Commit b477f12d authored by Nick Mathewson's avatar Nick Mathewson 🦀
Browse files

s/arti-arti-client/arti-client/ and regenerate readme files

parent 529d5d5e

crates/arti-client/README.md

+1 −1
Original line number Diff line number Diff line
@@ -4,7 +4,7 @@ High-level functionality for accessing the Tor network as a client. 


## Overview



The `arti-arti-client` crate aims to provide a safe, easy-to-use API for

The `arti-client` crate aims to provide a safe, easy-to-use API for

applications that want to use Tor network to anonymize their

traffic.  It hides most of the underlying detail, letting other

crates decide how exactly to use the Tor crate.

crates/arti-client/src/lib.rs

+1 −1
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ 
//!

//! # Overview

//!

//! The `arti-arti-client` crate aims to provide a safe, easy-to-use API for

//! The `arti-client` crate aims to provide a safe, easy-to-use API for

//! applications that want to use Tor network to anonymize their

//! traffic.  It hides most of the underlying detail, letting other

//! crates decide how exactly to use the Tor crate.

crates/tor-circmgr/src/lib.rs

+1 −1
Original line number Diff line number Diff line
@@ -288,7 +288,7 @@ impl<R: Runtime> CircMgr<R> { 
    /// # Note

    ///

    /// This function is invoked periodically from the

    /// `arti-arti-client` crate, based on timings from the network

    /// `arti-client` crate, based on timings from the network

    /// parameters.  Please don't invoke it on your own; I hope we can

    /// have this API go away in the future.

    ///

crates/tor-proto/README.md

+2 −2
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ Most people shouldn't use this crate directly, 
since its APIs are needlessly low-level for most purposes, and it is

easy to misuse them in an insecure or privacy-violating way.



Most people should use the [`tor-client`] crate instead.  This crate is

Most people should use the [`arti-client`] crate instead.  This crate is

of interest mainly for those that want to access the Tor protocols at

a low level.
@@ -50,7 +50,7 @@ about some Tor relays, and expose their information via 
[`tor_linkspec::ChanTarget`] and [`tor_linkspec::CircTarget`].

Currently, the [`tor-netdir`] crate is the easiest way to do so.



For an example of this crate in action, see the [`tor-client`]

For an example of this crate in action, see the [`arti-client`]

library, or the `arti` CLI.



## Design notes

crates/tor-protover/README.md

+1 −1
Original line number Diff line number Diff line
@@ -32,7 +32,7 @@ themselves depend on one another. (For example, [`tor-proto`] 
needs to know which variant of a subprotocol can be used with a

given relay, whereas [`tor-netdoc`] needs to parse lists of

subprotocol versions from directory documents.  Eventually,

[`tor-client`] will need to check its own list of supported

[`arti-client`] will need to check its own list of supported

protocols against the required list in the consensus.)



License: MIT OR Apache-2.0