diff --git a/README.md b/README.md index 2fd0a20..a0fa8eb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ [![Rust](https://github.com/the-lean-crate/cargo-diet/workflows/Rust/badge.svg)](https://github.com/the-lean-crate/cargo-diet/actions?query=workflow%3ARust) +[![Crates.io](https://img.shields.io/crates/v/cargo-diet.svg)](https://crates.io/crates/cargo-diet) `cargo diet` is a companion program of [The Lean Crate Initiative][lean-crate-initiative] to help computing 'optimal' `include` directives for your Cargo.toml manifest. 'optimal' here is the smallest size a crate can have while retaining everything relevant to building the code and populating `crates.io` and @@ -22,3 +23,36 @@ interfering with you on subsequent invocations. * **force computing an `include` directive even though one exists already** * `cargo diet -r` or `cargo diet --reset-manifest` * can also be used with `--dry-run` such as in `cargo diet --reset-manifest --dry-run` or `cargo diet -rn` + + +### Installation + +#### Using Cargo + +With a recent version of `cargo` (obtainable using [rustup][rustup]), the following should work: + +```bash +cargo install cargo-diet +``` + +[rustup]: https://rustup.rs/ + +#### Using GitHub releases + +Pre-built binaries can be found in the [releases](https://github.com/the-lean-crate/cargo-diet/releases) section of this repository. + + +### Development + +#### Run tests + +```bash +make journey-tests +``` + +#### Learn about other targets + +``` +make +``` +