Bump MSRV to 1.41.0 (#36)

[PAKEs.git] / README.md

diff --git a/README.md b/README.md
index c3275e987de3bd5e6720eac506f11c74033cc402..fd30837f30147545e5f7926bb0afbac9d3e49334 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
 # RustCrypto: PAKEs [![Build Status](https://travis-ci.org/RustCrypto/PAKEs.svg?branch=master)](https://travis-ci.org/RustCrypto/PAKEs)
 [Password-Authenticated Key Agreement][1] protocols implementation.
 
+[![dependency status](https://deps.rs/repo/github/RustCrypto/PAKEs/status.svg)](https://deps.rs/repo/github/RustCrypto/PAKEs)
+
 ## Warnings
 
 Crates in this repository have not yet received any formal cryptographic and
@@ -18,6 +20,23 @@ the memory.
 | [SRP][2]  | [![crates.io](https://img.shields.io/crates/v/srp.svg)](https://crates.io/crates/srp) | [![Documentation](https://docs.rs/srp/badge.svg)](https://docs.rs/srp) |
 | [spake2][4]  | [![crates.io](https://img.shields.io/crates/v/spake2.svg)](https://crates.io/crates/spake2) | [![Documentation](https://docs.rs/spake2/badge.svg)](https://docs.rs/spake2) |
 
+## Rust version requirements
+
+The MSRV (Minimum Supported Rust Version) is 1.32.0 . If/when this changes,
+it will be noted in the changelog, and the crate semver will be updated. So
+downstream projects should depend upon e.g. `spake2 = "0.2"` to avoid picking
+up new versions that would require a newer compiler.
+
+SRP-v0.4.1 actually works with rustc-1.31.1, but this will probably be
+changed in the next release.
+
+SPAKE2 required rustc-1.32 beginning with spake2-v0.2.0 .
+
+Our CI scripts check all builds against a pinned version of rustc to test the
+intended MSRV. Sometimes upstream dependencies make surprising changes that
+could require a newer version of rustc, without changes to the source code in
+this repository, but hopefully this won't happen very frequently.
+
 ## License
 
 All crates are licensed under either of