mirrors/arti.git/README.md, branch arti-v0.0.3

Check off some large items in README.md

2022-01-11T14:24:07Z

readme: Add crates.io badge at the top

2021-10-29T16:15:18Z

Signed-off-by: David Goulet

Improve and future-proof the `arti` CLI

2021-10-27T18:11:48Z

This switches out `arti`'s argument-parsing library with `clap`, which is a lot more featureful (and very widely used within the Rust ecosystem). We also now use a lot of `clap`'s features to improve the CLI experience: - The CLI now expects a subcommand (currently, either "help", or "proxy" for the existing SOCKS proxy behaviour). This should let us add additional non-SOCKS-proxy features to arti in future. - `clap` supports default values determined at runtime, so the way the default config file is loaded was changed: now, we determine the OS-specific path for said file before invoking `clap`, so the help command can show it properly. - The behaviour of `tor_config` was also changed; now, one simply specifies a list of configuration files to load, together with whether they're required. - That function also way overused generics; this has been fixed. - Instead of using the ARTI_LOG environment variable to configure logging, one now uses the `-l, --log-level` CLI option. (The intent is for this option to be more discoverable by users.) - The `proxy` subcommand allows the user to override the SOCKS port used on the CLI without editing the config file.

Update our disclaimers and limitations sections.

2021-10-27T15:13:46Z

Fix typos and cleanup

2021-10-25T16:58:42Z

Rename tor_client/arti_tor_client to arti_client.

2021-10-21T18:22:11Z

Solves a name conflict with the existing tor_client create. Closes #130.

Move MSRV note to README

2021-08-24T19:53:43Z

Run "typos" to fix a few more typos.

2021-06-17T22:45:05Z

Revise repository-level documentation

2021-06-17T16:18:28Z

add rustdoc link to readme

2021-06-09T18:36:59Z