Merge pull request #207 from fitzgen/document-msrv-policy

Formalize and document the MSRV policy

Author: Manishearth

Cargo.toml

@@ -17,7 +17,7 @@ description = "The trait for generating structured data from unstructured data"
 license = "MIT OR Apache-2.0"
 repository = "https://github.com/rust-fuzz/arbitrary/"
 documentation = "https://docs.rs/arbitrary/"
-rust-version = "1.63.0"
+rust-version = "1.63.0" # Keep in sync with version documented in the README.md
 
 [dependencies]
 derive_arbitrary = { version = "1.4.0", path = "./derive", optional = true }

README.md

@@ -120,6 +120,16 @@ impl<'a> Arbitrary<'a> for Rgb {
 }
 ```
 
+## Minimum Supported Rust Version (MSRV)
+
+<!-- NB: Keep this number in sync with the `rust-version` in `Cargo.toml`. -->
+
+This crate is guaranteed to compile on stable Rust **1.63.0** and up. It might
+compile with older versions but that may change in any new patch release.
+
+We reserve the right to increment the MSRV on minor releases, however we will
+strive to only do it deliberately and for good reasons.
+
 ## License
 
 Licensed under dual MIT or Apache-2.0 at your choice.