summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* Improve documentation around Cargo features; make Runtime require Debugeta2022-05-111-2/+24
| | | | | | | | | | | | | | - 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.Nick Mathewson2022-04-251-1/+1
| | | | | | | | | | | | | 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 httpSamanta Navarro2022-04-201-2/+2
| | | | Keep http in license text.
* Update README in preparation for 0.1.0 release.Nick Mathewson2022-02-281-8/+9
|
* README,CONTRIBUTING: More links.Nick Mathewson2022-01-211-0/+11
| | | | | | | 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.Nick Mathewson2022-01-191-5/+10
| | | | Closes #283.
* Check off some large items in README.mdNick Mathewson2022-01-111-4/+4
|
* readme: Add crates.io badge at the topDavid Goulet2021-10-291-0/+2
| | | | Signed-off-by: David Goulet <[email protected]>
* Improve and future-proof the `arti` CLIeta2021-10-271-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | 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.Nick Mathewson2021-10-271-15/+15
|
* Fix typos and cleanupDimitris Apostolou2021-10-251-2/+2
|
* Rename tor_client/arti_tor_client to arti_client.Nick Mathewson2021-10-211-1/+1
| | | | | | Solves a name conflict with the existing tor_client create. Closes #130.
* Move MSRV note to READMENick Mathewson2021-08-241-0/+9
|
* Run "typos" to fix a few more typos.Nick Mathewson2021-06-171-2/+2
|
* Revise repository-level documentationNick Mathewson2021-06-171-260/+97
|
* add rustdoc link to readmeNick Mathewson2021-06-091-0/+2
|
* Mention tor-units in the readmeNick Mathewson2021-05-251-0/+2
|
* Small updates to READMENick Mathewson2021-05-241-4/+10
|
* Remove notes about prop#318, which _has_ been accepted.Nick Mathewson2021-05-211-1/+0
|
* Move our command-line interface into a new crate called "arti".Nick Mathewson2021-03-171-2/+2
| | | | Closes #106
* Update docs wrt tokio a bitNick Mathewson2021-03-021-3/+4
|
* Merge remote-tracking branch 'origin/mr/14' into mainNick Mathewson2021-02-091-0/+2
|\
| * Add a rough CONTRIBUTING.md file with some dogfooding instructions.George Kadianakis2021-02-081-0/+2
| |
* | Remove the TODO file in favor of gitlab.Nick Mathewson2021-02-051-2/+1
|/
* Rename client-demo to tor-client.Nick Mathewson2021-02-021-3/+3
|
* Mention tor-consdiff in list of cratesNick Mathewson2020-12-171-0/+2
|
* Document newer modulesNick Mathewson2020-11-251-7/+27
|
* Update README to mention current state.Nick Mathewson2020-11-251-14/+16
|
* More notes in README.md: assumed proposals, stability (non)guaranteeNick Mathewson2020-10-181-0/+8
|
* List supported/unsupported subprotocols in the READMENick Mathewson2020-10-181-1/+58
|
* Revise TODO and README; declare "milestone 2" done.Nick Mathewson2020-10-131-6/+5
| | | | | | Part of this "declaring milestone 2 done" business is a matter of putting additional tests and documentation into milestone 3 where they logically belong.
* README editsNick Mathewson2020-09-301-10/+19
|
* Split the cell-handling parts of tor-proto into a new crate.Nick Mathewson2020-09-261-5/+8
|
* readme editsNick Mathewson2020-09-261-8/+10
|
* Update TODO and README.Nick Mathewson2020-09-251-1/+3
|
* Update documentationNick Mathewson2020-09-211-4/+11
|
* yet more readme updtesNick Mathewson2020-09-131-2/+7
|
* more readme tweaksNick Mathewson2020-09-121-4/+3
|
* Explain the demo in the readme.Nick Mathewson2020-09-121-0/+7
|
* update readmeNick Mathewson2020-09-091-7/+18
|
* Small readme editNick Mathewson2020-08-281-2/+3
|
* One more disclaimer in the READMENick Mathewson2020-05-091-0/+8
|
* improve the README a littleNick Mathewson2020-05-091-3/+27
|
* Fix some markdown in README.md.Nick Mathewson2020-05-081-34/+40
| | | | | | | | | Markdown breakage 1: The internet led me to believe this is how you did a <dl> in markdown. Apparently it wasn't. Markdown breakage 2: I forgot how lists work! Also, add a paragraph about stuff you can try.
* fold plan into readmeNick Mathewson2020-05-081-0/+9
|
* license clarity and contribution noticeNick Mathewson2020-05-081-0/+20
|
* Fresh git repository for work on "arti"Nick Mathewson2020-05-071-0/+105
Arti is a rust tor implementation. It's project I've been working on for a few months now, in weekends and in spare time. It doesn't speak the tor protocol yet, and it doesn't connect to the network at all. It needs much more documentation and testing, but I'm just about ready to show it to others. See the README.md for a description of what is there and what isn't.
generated by cgit v1.2.3 (git 2.46.0) at 2026-08-26 21:20:47 +0000