Skip to content

[repo-health] Medium: Crate not published on crates.io — installation instructions and README badges are broken #8

@Liohtml

Description

@Liohtml

Summary

The crate is not published on crates.io, but the README presents it as an installable library with [dependencies] apify-rust-client = \"0.1\". Both badges link to pages that return 404/error. Any user following the README will fail to install the crate.

Category

README / Documentation

Severity

Medium

Location

  • File: README.md — installation section + badge row
  • File: Cargo.tomldocumentation = "https://docs.rs/apify-rust-client"

Details

Verified via the crates.io API (/api/v1/crates/apify-rust-client) — the crate does not exist on the registry. Consequences:

  1. [![crates.io](https://img.shields.io/crates/v/...)] badge shows invalid
  2. [![docs.rs](https://docs.rs/apify-rust-client/badge.svg)] badge and link 404
  3. The [dependencies] apify-rust-client = "0.1" snippet fails — cargo add returns an error
  4. Cargo.toml documentation field points to a non-existent docs.rs page

Suggested Fix

Either:

  • A (publish): Run cargo publish to push the crate to crates.io, then add a CODEOWNERS / cargo-release workflow.
  • B (git dep): Replace the installation snippet with a git dependency until ready to publish:
    [dependencies]
    apify-rust-client = { git = "https://github.com/Liohtml/apify-rust-client" }
    And update or remove the crates.io / docs.rs badges.

Effort Estimate

15 min (update README) or 30 min (publish to crates.io)


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