summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index 645ce4243..3cca7d1b1 100644
--- a/README.md
+++ b/README.md
@@ -148,6 +148,17 @@ That library's API will allow you to
make connections over the Tor network,
and obtain streams/sinks usable from async Rust.
+We make fairly frequent semver bumps the Arti library API,
+and to our lower-level crates.
+However, in practice, we don't often make disruptive changes
+that aren't easy to sort out in a dependency.
+When using Arti as a library, you should be prepared to make regular updates,
+bumping your versions requirement, not just `cargo update`.
+`cargo upgrade` can help with this.
+
+See [our version update and API compatibility policy](doc/Semver.md)
+for more details.
+
## Minimum supported Rust Version
Our current Minimum Supported Rust Version (MSRV) is 1.70.