summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* README: Remove duplicate link to CONTRIBUTING.mdhashcatHitman2025-03-261-6/+2
| | | | We already link to CONTRIBUTING.md near the top of the README in the "Links" section. There's no real need to add two additional links beyond that, especially if they're going to be in very similar looking sections. So we remove one and modify the other to look a little nicer. I've opted to keep the one closer to the end of the README since the top of the README is already covered by the "Links" section.
* README: Update anonticket URL.Gabriela Moldovan2024-11-071-1/+1
| | | | | @ahf tells me anonticket is at https://anonticket.torproject.org/ nowadays.
* Default allow_onion_addrs to true.Wesley Aptekar-Cassels2024-10-071-29/+0
| | | | | | | This was disabled due to lack of vanguard support. Now that we support vanguards, we should enable this by default. Fixes: #1402
* Upgrade MSRV to 1.77Nick Mathewson2024-09-251-1/+1
| | | | This will allow us to upgrade to the latest version of rusqlite.
* Bump MSRV from 1.70 to 1.75.Wesley Aptekar-Cassels2024-09-161-1/+1
|
* doc: Use locked buildpinkforest2024-05-161-2/+2
|
* Add a note about LGPL, rust, and binary distribution.Nick Mathewson2024-04-291-2/+6
|
* Add note re LGPL to README.me License sectionIan Jackson2024-04-251-0/+5
|
* README: suggest use of cargo upgrade.Ian Jackson2024-03-251-0/+1
|
* doc/Semver.md: Add semver policyIan Jackson2024-03-251-0/+3
| | | | | | Taken from https://gitlab.torproject.org/tpo/core/arti/-/issues/1005#note_2991812 and edited.
* README: Document our semver approachIan Jackson2024-03-251-0/+7
| | | | Even before the policy change, this is, in practice, true.
* Check off onion services in the top-level README.Nick Mathewson2024-02-221-1/+1
|
* README: change MSRV to 1.70Nick Mathewson2023-11-281-1/+1
|
* update Onion Support commandLowLandMink5432023-10-071-1/+1
|
* README: Note more details about upcoming milestonesNick Mathewson2023-08-041-2/+6
|
* Add `doc/safer_build.md` to explain path anonymizationNick Mathewson2023-07-241-0/+8
| | | | | | | Otherwise our default build instructions will lead people to build binaries that include their home directory. Closes #957 for now.
* README: document how to test .onion connectionsIan Jackson2023-06-291-0/+8
| | | | | Not giving Tor Browser instructions just yet because of the security caveat.
* README: explain how to turn on HS client supportIan Jackson2023-06-291-0/+21
|
* Add a couple of links to the top-level README.Nick Mathewson2023-05-011-0/+9
| | | | | Notably, I'm adding a note to the `arti` README, which includes information on how to build and use the thing.
* Update MSRV in READMENick Mathewson2023-04-111-1/+1
|
* Fix typosDimitris Apostolou2023-01-071-1/+1
|
* doc: fix links to Architecture.mdEmil Engler2022-12-201-1/+1
| | | | See 2c240923fcd0cec75087db39e461ee718228ea14.
* Check off items in README.md, remove inaccurate parentheticals.Nick Mathewson2022-11-291-4/+4
|
* bump rust-version to 1.60 in every crate.Nick Mathewson2022-11-101-1/+1
|
* READMEs: toplevel: Remove caveats, add xrefs, and tidyingIan Jackson2022-09-021-31/+33
|
* 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
|
generated by cgit v1.2.3 (git 2.46.0) at 2026-08-26 20:52:04 +0000