summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 20 insertions, 4 deletions
diff --git a/README.md b/README.md
index 254d89f..a0b8059 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,39 @@
# ipfs-api
-[![Travis](https://img.shields.io/travis/ferristseng/rust-ipfs-api.svg)](https://travis-ci.org/ferristseng/rust-ipfs-api)
+[![Status](https://github.com/ferristseng/rust-ipfs-api/workflows/Rust/badge.svg?branch=master)](https://github.com/ferristseng/rust-ipfs-api/actions?query=workflow%3ARust)
[![Crates.io](https://img.shields.io/crates/v/ipfs-api.svg)](https://crates.io/crates/ipfs-api)
[![Docs.rs](https://docs.rs/ipfs-api/badge.svg)](https://docs.rs/ipfs-api/)
-Rust library for connecting to the IPFS HTTP API using tokio.
+Rust library for connecting to the IPFS HTTP API using Hyper/Actix.
### Usage
```toml
[dependencies]
-ipfs-api = "0.7.2"
+ipfs-api = "0.11.0"
```
+#### Feature Flags
You can use `actix-web` as a backend instead of `hyper`.
```toml
[dependencies]
-ipfs-api = { version = "0.7.2", features = ["actix"], default-features = false }
+ipfs-api = { version = "0.11.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.11.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.11.0", features = ["with-hyper-rustls", "with-builder"], default-features = false }
```
### Examples