summaryrefslogtreecommitdiff
path: root/crates
diff options
context:
space:
mode:
Diffstat (limited to 'crates')
-rw-r--r--crates/arti-bench/README.md3
-rw-r--r--crates/arti-client/README.md4
2 files changed, 5 insertions, 2 deletions
diff --git a/crates/arti-bench/README.md b/crates/arti-bench/README.md
index fff51d387..79cea71e0 100644
--- a/crates/arti-bench/README.md
+++ b/crates/arti-bench/README.md
@@ -2,4 +2,7 @@
A simple benchmarking utility for Arti.
+This works by establishing a simple TCP server, and having Arti connect back to it via
+a `chutney` network of Tor nodes, benchmarking the upload and download bandwidth while doing so.
+
License: MIT OR Apache-2.0
diff --git a/crates/arti-client/README.md b/crates/arti-client/README.md
index fc724f69a..936a18f42 100644
--- a/crates/arti-client/README.md
+++ b/crates/arti-client/README.md
@@ -54,7 +54,7 @@ If you really want to connect to a raw IP address and know what you're doing, ta
```rust
// The client configuration describes how to connect to the Tor network,
// and what directories to use for storing persistent state.
-let config = TorClientConfig::sane_defaults()?;
+let config = TorClientConfig::default();
// Arti needs a handle to an async runtime in order to spawn tasks and use the
// network. (See "Multiple runtime support" below.)
let rt = tor_rtcompat::tokio::current_runtime()?;
@@ -65,7 +65,7 @@ let rt = tor_rtcompat::tokio::current_runtime()?;
let tor_client = TorClient::bootstrap(rt, config).await?;
// Initiate a connection over Tor to example.com, port 80.
-let mut stream = tor_client.connect(("example.com", 80), None).await?;
+let mut stream = tor_client.connect(("example.com", 80)).await?;
use futures::io::{AsyncReadExt, AsyncWriteExt};