Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 3.04 KB

README.md

File metadata and controls

54 lines (36 loc) · 3.04 KB
Raw

📇 tame-index

Small crate for interacting with cargo registry indices

Embark Embark Crates.io Docs dependency status Build status

Differences from crates-index

  1. The API exposes enough pieces where an alternative git implementation can be used if gix is not to your liking.
  2. Sparse index support via reqwest is optional, gated behind the sparse feature flag.
  3. Local cache files are always supported regardless of features enabled
  4. ComboIndexCache (local cache files only) and ComboIndex (cache + remote capabilities) are provided to wrap git indices, sparse indices, or local registries depending on the the index URL.
  5. Functionality for writing cache entries to the local index cache is exposed in the public API
  6. Local Registry support is available behind the local feature flag
  7. Building of local registries is available behind the local-builder feature flag
  8. File-based locking compatible with Cargo is available to ensure tame-index and Cargo can play nicely together.

Contributing

Contributor Covenant

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started. Please also read our Contributor Terms before you make any contributions.

Any contribution intentionally submitted for inclusion in an Embark Studios project, shall comply with the Rust standard licensing model (MIT OR Apache 2.0) and therefore be dual licensed as described below, without any additional terms or conditions:

License

This contribution is dual licensed under EITHER OF

at your option.

For clarity, "your" refers to Embark or any other licensee/user of the contribution.