From 49645e26e35bd8ed62490ca2bbde9ffb3dd0db3c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Siedlaczek?= Date: Tue, 21 Apr 2020 19:39:59 -0400 Subject: [PATCH] Update README.md --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/README.md b/README.md index 86b902a..deacd4d 100644 --- a/README.md +++ b/README.md @@ -24,3 +24,37 @@ To convert a CIFF blob to a PISA canonical: To convert a PISA canonical to a CIFF blob: `./target/release/pisa2ciff` +## Install + +You can also install the binaries to your local `cargo` repository: + +``` +cargo install --path . +``` + +or if you are installing the same version again: + +``` +cargo install --path . --force +``` + +## Install from crates.io + +The library and the tools are also available in crates.io, so you can install the binaries in your local repository by running: + +``` +cargo install ciff +``` + +## Use as Cargo dependency + +If you are insterested in using the library components in your own Rust library, you can simply defeine it as a dependency in your `Cargo.toml` file: + +```toml +[dependencies] +ciff = "0.1" +``` + +## Library API documentation + +The API documentation is available on [docs.rs](https://docs.rs/ciff).