mirrors/arti.git/README.md, branch arti-v1.0.0

Improve documentation around Cargo features; make Runtime require Debug

2022-05-11T12:26:35Z

- arti#445 highlighted the lack of good documentation around Arti's multiple runtime support, as well as it being difficult to determine what runtime was actually in use. - Improve the documentation to solve the first problem. - To solve the second problem, make Runtime require Debug (which is arguably a good idea anyway, since it makes them easier to embed in things), and print out the current runtime's Debug information when arti is invoked with `--version`. - (It also prints out other Cargo features, too!) fixes arti#445

Increase our MSRV to 1.56.

2022-04-25T17:03:31Z

Our support policy says that we can update to any Rust released at least 6 months ago; 1.56 came out on 21 October 2021. This doesn't yet change any code: it just increases the version we say we need in our README, and the version we test against in CI. Our main justification for this change is to be able to upgrade to newer versions of our dependencies, including `async_executors` >= 0.5, `aes` >= 0.8, and `cipher` >= 0.4.

Use https instead of http

2022-04-20T11:48:55Z

Keep http in license text.

Update README in preparation for 0.1.0 release.

2022-02-28T19:25:08Z

README,CONTRIBUTING: More links.

2022-01-21T15:59:14Z

Explain how to report bugs and how get accounts on the bugtracker; add link to the troubleshooting document. Part of #277

Adopt an initial MSRV policy.

2022-01-19T14:02:39Z

Closes #283.

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