summaryrefslogtreecommitdiff
path: root/crates/arti-client/README.md
Commit message (Collapse)AuthorAgeFilesLines
* arti-client: document the need for `tor_log_ratelim::install_runtime()`Steven Engler2026-01-141-0/+25
| | | | | | This function can only be called once within a program, so we can't call it ourselves from a `TorClient`. The user must call it themselves, so we should document this.
* arti-client: document the 'vanguards' feature in the READMESteven Engler2025-11-261-0/+3
|
* docs: remove outdated comments about rustls/ring licenseSteven Engler2025-08-211-3/+1
|
* smol: Implement smol in tor-rtcompatNiel Duysters2025-08-211-5/+6
|
* arti-client: make "memquota" feature a no-opSteven Engler2025-07-311-1/+8
|
* arti: Add keys list and keys list-keystoreshjrgrn2025-06-121-2/+4
|
* arti-client README: Document undesirable exit(1) behavior.Nick Mathewson2025-04-161-1/+12
|
* arti-client: xref to fork policyIan Jackson2025-04-071-0/+5
|
* Make memquota feature part of full in arti-clientIan Jackson2024-10-221-0/+1
| | | | Mark it no longer experimental, but part of full. And document it.
* Documentation updates for "NetStreamProvider" renameNick Mathewson2024-09-241-1/+1
| | | | | | Stop referring to TCP streams in its documentation; update other documentation to refer to NetStreamProvider rather than TcpProvider.
* Remove reference to arti-hyper in arti-client README.mdIan Jackson2024-07-091-2/+0
| | | | | | | | As per https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/2225#note_3043992 We have an example for how to use arti-client with hyper 1.x, but I don't think we need to to mention that here.
* Move onion-service-service to non-experimental section of READMEs.Nick Mathewson2024-02-201-3/+3
|
* Use and document the new arti-client/anyhow featureNick Mathewson2024-02-151-0/+2
|
* arti-client: Fix a couple more typos.Nick Mathewson2023-08-221-1/+1
| | | | I spotted these while I was working on something else.
* Update documentation regarding the `onion-service-client` featureKunal Mehta2023-07-071-3/+3
| | | | | It is no longer experimental, but still not rated for security-sensitive usage per <https://blog.torproject.org/arti_116_released/>.
* arti-client: Rename hs feature to onion-service-clientIan Jackson2023-06-161-1/+1
| | | | | | Rationale as per #756. This is the same name as in the `arti` crate.
* arti-client: Use a dummy key manager if the keymgr feature is disabled.Gabriela Moldovan2023-06-151-0/+2
| | | | | | | | | TorClient now only uses the tor_keymgr::KeyMgr implementation if the keymgr experimental feature is enabled. If the feature is disabled, a dummy key manager implementation is used. The new `keymgr` feature depends on `onion-client`, because the key manager is only used for HS client auth.
* Merge branch 'pt-snowflake' into 'main'Nick Mathewson2023-06-111-0/+9
|\ | | | | | | | | | | | | add documentation for configuring snowflake pt Closes #879 and #875 See merge request tpo/core/arti!1216
| * add a few more comments on PTstrinity-1686a2023-06-091-2/+3
| |
| * change link for more information on ptstrinity-1686a2023-06-081-1/+1
| |
| * complement general documentation on bridges and pttrinity-1686a2023-06-071-0/+8
| |
* | Rephrase error handling to reportingSaksham Mittal2023-06-081-2/+2
| |
* | Add error handling section in READMESaksham Mittal2023-06-081-0/+40
|/
* Make a top-level API for connecting to onion services.Nick Mathewson2023-01-121-0/+3
| | | | Fortunately, it adds very little to the arti-client API surface.
* arti-client: Mark "bridge-client" and "pt-client" as non-experimentalNick Mathewson2022-11-181-2/+2
|
* Check more targetstrinity-1686a2022-11-101-0/+2
|
* README doctests: fix arti-clientIan Jackson2022-10-121-3/+3
| | | | | | | | Add ,ignore to ignore three examples that don't actually compile. cargo readme would add these annotations to lib.rs, but the doc include doesn't do stuff like that. pandoc seems to still render the result just fine.
* Add pt-client and bridge-client features to arti and arti-clientIan Jackson2022-10-121-0/+2
|
* READMEs: Run maint/readmes (to update READMEs from lib.rs)Ian Jackson2022-09-021-1/+2
|
* READMEs: arti-client: Remove caveats and add some xrefsIan Jackson2022-09-021-7/+15
|
* Update README.md files with "readmes" tool.Nick Mathewson2022-08-311-1/+5
|
* Update README.md files from rustdoc.Nick Mathewson2022-06-241-41/+77
|
* Update README.md files (automated).Nick Mathewson2022-05-061-1/+1
|
* Fix grammar and typosSamanta Navarro2022-04-271-1/+1
|
* Update README.md files using readmes scriptNick Mathewson2022-03-291-0/+2
|
* Fixed typo on arti-client README.mdsolanav2022-03-241-2/+0
|
* Update README.md files from rustdoc.Nick Mathewson2022-03-011-79/+99
|
* Add missing documentation for TLS features to two readmesIan Jackson2022-02-231-0/+2
|
* errors: Introduce error_detail featureIan Jackson2022-02-041-0/+3
| | | | | Right now we must always expose the `Error` type since we haven't converted everything.
* Use script to update README.md files.Nick Mathewson2022-01-281-6/+8
|
* StreamPrefs: rename from ConnectPrefsIan Jackson2022-01-211-1/+1
| | | | | | | | | | | | | The docs even say this is about stream. As @nickm writes in https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/252#note_2771289 we generally call end-to-end connections that are tunneled over Tor "Streams" to distinguish them from everything else in the Tor protocols that could possibly be called a "Connection". That seems to apply here too.
* Update README.md files (automated)Nick Mathewson2022-01-111-2/+2
|
* Example needs to be the same as the readmedagon2021-11-301-46/+27
|
* MR review feedbackdagon2021-11-301-3/+8
|
* fix arti-client doc exampledagon2021-11-301-25/+39
|
* run ./maint/readmes.shdagon2021-11-291-2/+2
|
* Update README.md filesNick Mathewson2021-10-291-6/+10
|
* Update README.md filesNick Mathewson2021-10-281-13/+90
|
* Update our disclaimers and limitations sections.Nick Mathewson2021-10-271-16/+7
|
* s/arti-arti-client/arti-client/ and regenerate readme filesNick Mathewson2021-10-251-1/+1
|