diff options
| author | Nick Mathewson <nickm@torproject.org> | 2022-02-28 14:29:50 -0500 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2022-02-28 14:29:50 -0500 |
| commit | 9bf69f551ee5d05889cd449737f064448a5d6f30 (patch) | |
| tree | a742555f3b3cc666a003c9a95fb1e4be81fb74a9 | |
| parent | dd8cd0869178699d513cb4a384795f8cb544f16d (diff) | |
| download | arti-9bf69f551ee5d05889cd449737f064448a5d6f30.tar.gz arti-9bf69f551ee5d05889cd449737f064448a5d6f30.zip | |
Update our stability warning on arti-client.
| -rw-r--r-- | crates/arti-client/src/lib.rs | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/crates/arti-client/src/lib.rs b/crates/arti-client/src/lib.rs index d9065ec76..5a81318aa 100644 --- a/crates/arti-client/src/lib.rs +++ b/crates/arti-client/src/lib.rs @@ -17,11 +17,18 @@ //! //! Note that Arti is a work in progress; although we've tried to write all the //! critical security components, you probably shouldn't use Arti in production -//! until it's a bit more mature. -//! -//! Also note that all of the APIs for this crate, and for Arti in general, are -//! not the least bit stable. If you use this code, please expect your software -//! to break on a regular basis. +//! until it's a bit more mature. (That said, now is a _great_ time to try +//! our Arti on an experimental basis, so you can tell us what we need +//! to fix between now and the 1.0.0 release.) +//! +//! Also note that the APIs for this crate are not all yet +//! completely stable. We'll try not to break things without good +//! reason, and we'll follow semantic versioning when we do, but +//! please expect a certain amount of breakage between now and 1.0.0. +//! +//! The APIs exposed by lower-level crates in Arti are _even more +//! unstable_; they will break more often than those from +//! `arti-client`, for less reason. //! //! # Using `arti-client` //! |