Differences from crates-index
- The API exposes enough pieces where an alternative git implementation can be used if
gix
is not to your liking. - Sparse index support via
reqwest
is optional, gated behind thesparse
feature flag. - Local cache files are always supported regardless of features enabled
ComboIndexCache
(local cache files only) andComboIndex
(cache + remote capabilities) are provided to wrap git indices, sparse indices, or local registries depending on the the index URL.- Functionality for writing cache entries to the local index cache is exposed in the public API
Local Registry
support is available behind thelocal
feature flag- Building of local registries is available behind the
local-builder
feature flag - File-based locking compatible with Cargo is available to ensure
tame-index
and Cargo can play nicely together.
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:
This contribution is dual licensed under EITHER OF
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
For clarity, "your" refers to Embark or any other licensee/user of the contribution.