From 84d017795e8c6f58a668fe8a8564c6dcccfe2bee Mon Sep 17 00:00:00 2001 From: Sarah Jamie Lewis Date: Wed, 13 Jan 2021 17:46:28 -0800 Subject: [PATCH] Updating README --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3d28256..29333a7 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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"]}