diff options
| author | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2022-03-01 11:08:52 +0000 |
|---|---|---|
| committer | Ian Jackson <ijackson@chiark.greenend.org.uk> | 2022-03-01 11:53:15 +0000 |
| commit | 4fa78e3f440fc5a01eef11b78318755d6cb6a7bb (patch) | |
| tree | fb22d5580c691fd800bc653e6a1d1ff937cb814d | |
| parent | b083ae661e6d2862b38cfc15aee022b9aed4dca3 (diff) | |
| download | arti-4fa78e3f440fc5a01eef11b78318755d6cb6a7bb.tar.gz arti-4fa78e3f440fc5a01eef11b78318755d6cb6a7bb.zip | |
arti-hyper: Upgrade from an example to an "adaptation layer"
| -rw-r--r-- | crates/arti-hyper/src/lib.rs | 8 | ||||
| -rw-r--r-- | doc/Architecture.md | 2 |
2 files changed, 9 insertions, 1 deletions
diff --git a/crates/arti-hyper/src/lib.rs b/crates/arti-hyper/src/lib.rs index 643a52f07..f39320a5b 100644 --- a/crates/arti-hyper/src/lib.rs +++ b/crates/arti-hyper/src/lib.rs @@ -1,4 +1,12 @@ //! High-level layer for making http(s) requests the Tor network as a client. +//! +//! This can be used by applications which embed Arti, +//! and could also be used as an example of how to build on top of [`arti_client`]. +//! +//! There is an example program [`hyper.rs`] which uses `arti-hyper` +//! to connect to Tor and make a single HTTP\[S] request. +//! +//! [`hyper.rs`]: <https://gitlab.torproject.org/tpo/core/arti/-/blob/main/crates/arti-hyper/examples/hyper.rs> #![deny(missing_docs)] #![warn(noop_method_call)] diff --git a/doc/Architecture.md b/doc/Architecture.md index 476a9c199..e14b5aa0e 100644 --- a/doc/Architecture.md +++ b/doc/Architecture.md @@ -107,7 +107,7 @@ before Arti 1.0.0. `arti-bench`: A testing crate for running performance tests. -`arti-hyper`: An example crate, using `arti_client` as a backend for the +`arti-hyper`: Adaptation layer for using `arti_client` as a backend for the `hyper` HTTP library. ## Design considerations, privacy considerations. |