diff options
| author | Ferris Tseng <ferristseng@fastmail.fm> | 2021-01-18 22:24:56 -0500 |
|---|---|---|
| committer | Ferris Tseng <ferristseng@fastmail.fm> | 2021-01-18 22:24:56 -0500 |
| commit | 4b2825ede3831374f1a6691e787124e762f62454 (patch) | |
| tree | 0b6c60e6a6ab9f46e569558f3162c18ad5c15698 | |
| parent | 0743586b736d6b517f61e7dc525201eddb8d42f7 (diff) | |
increment version and add docs for feature flags
| -rw-r--r-- | ipfs-api/Cargo.toml | 2 | ||||
| -rw-r--r-- | ipfs-api/src/lib.rs | 20 |
2 files changed, 19 insertions, 3 deletions
diff --git a/ipfs-api/Cargo.toml b/ipfs-api/Cargo.toml index 1520c95..da8754b 100644 --- a/ipfs-api/Cargo.toml +++ b/ipfs-api/Cargo.toml @@ -7,7 +7,7 @@ documentation = "https://docs.rs/ipfs-api" repository = "https://github.com/ferristseng/rust-ipfs-api" keywords = ["ipfs"] categories = ["filesystem", "web-programming"] -version = "0.9.0" +version = "0.10.0" readme = "../README.md" license = "MIT OR Apache-2.0" diff --git a/ipfs-api/src/lib.rs b/ipfs-api/src/lib.rs index df5dea2..6e14849 100644 --- a/ipfs-api/src/lib.rs +++ b/ipfs-api/src/lib.rs @@ -14,14 +14,30 @@ //! //! ```toml //! [dependencies] -//! ipfs-api = "0.9.0" +//! ipfs-api = "0.10.0" //! ``` +//! ### Feature Flags //! //! You can use `actix-web` as a backend instead of `hyper`. //! //! ```toml //! [dependencies] -//! ipfs-api = { version = "0.9.0", features = ["with-actix"], default-features = false } +//! ipfs-api = { version = "0.10.0", features = ["with-actix"], default-features = false } +//! ``` +//! +//! You also have the option of using [`rustls`](https://crates.io/crates/rustls) +//! instead of native tls: +//! +//! ```toml +//! [dependencies] +//! ipfs-api = { version = "0.10.0", features = ["with-hyper-rustls"], default-features = false } +//! ``` +//! +//! To enable the builder pattern (default) use the `with-builder` feature: +//! +//! ```toml +//! [dependencies] +//! ipfs-api = { version = "0.10.0", features = ["with-hyper-rustls", "with-builder"], default-features = false } //! ``` //! //! ## Examples |