Skip to content

Publish to crates.io #3

Description

@saimskywalker

The crate is on GitHub only, so the only way to use it is a git dependency and the only way to find it is to already know it exists.

Why this is the highest-value item on the list

crates.io pages rank well in search. Someone typing "SNI 1729 rust" or "perhitungan struktur baja library" will not find a GitHub repository easily, but a crates.io page with a clear description has a real chance. docs.rs then builds and hosts the API documentation for free, which is a second indexed surface with every public item on it.

For a library nobody has heard of, publication is worth more than another feature.

Before publishing

  • Confirm the crate name is free on crates.io
  • cargo publish --dry-run passes
  • description, keywords, categories, repository and readme are all set in Cargo.toml, since those are the searchable fields
  • The disclaimer about this being a calculation aid appears in the crate-level docs, not only in the README, because docs.rs shows the former
  • Decide the version. 0.1.0 is honest for the current coverage
  • Add a cargo publish --dry-run step to CI so a broken manifest is caught before a release, not during one

Note

Publishing is close to irreversible: a version can be yanked but not deleted, and the name is taken permanently. Worth being deliberate about the name and the initial API surface.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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