Updating README

This commit is contained in:
Sarah Jamie Lewis 2021-01-13 17:46:28 -08:00
parent 178f426c7e
commit 84d017795e
1 changed files with 10 additions and 3 deletions

View File

@ -6,10 +6,17 @@ Very WIP. Currently supports authentication over Tor v3 onion services aligned w
Run an ephemeral server:
cargo run --example simple_server
cargo run --example simple_server --features onionv3
Update `examples/simple_client.rs` to connect to the address generated by `simple_server` and then run:
cargo run --example simple_client
cargo run --example simple_client --features onionv3
Both the server and client should authenticate each other.
Both the server and client should authenticate each other.
## Using the Library
We recommend you build with the `onionv3` feature enabled (in the future Tapir may support other anonymous communication
networks, but for now only Tor onion v3 services are supported).
tapir-cwtch = {version="0.1.8", features=["onionv3"]}