Skip to content

[repo-health] Medium: README installation example uses path dependency — unusable for external consumers #10

@Liohtml

Description

@Liohtml

Summary

The README's installation section shows linkedin-scraper = { path = "." } as the Cargo.toml dependency, which only works when the consumer has the repo cloned locally. No git or crates.io dependency form is documented.

Category

README

Severity

Medium

Location

  • File: README.md
  • Line: 36

Details

[dependencies]
linkedin-scraper = { path = "." }  # only works locally

Any developer following the README to add this as a dependency in their own project will get:

error: failed to load manifest for dependency...
  path "." does not exist

The crate is not published to crates.io, so the correct form for external consumers would be a git dependency.

Suggested Fix

Update the README installation section to show the git dependency form:

[dependencies]
linkedin-scraper = { git = "https://github.com/Liohtml/RUSTlinkedin_scraper" }

If the intent is to eventually publish to crates.io, add a note:

# When published:
# linkedin-scraper = "0.1"

# Until then, use the git form:
linkedin-scraper = { git = "https://github.com/Liohtml/RUSTlinkedin_scraper" }

Effort Estimate

5 min


Automated finding by repo-health-agent v1.0

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions