X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=fd30837f30147545e5f7926bb0afbac9d3e49334;hb=9f42267e1a968c26b9785af79f56dd3cdc9ddf5a;hp=0d32749682af772b044bcfc71fe9defa0eb7a335;hpb=f6e9d07dffa9a9b39f203c23043f93337ebe1ab6;p=PAKEs.git

diff --git a/README.md b/README.md
index 0d32749..fd30837 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,58 @@
-# spake2.rs
-The SPAKE2 password-authenticated key-exchange algorithm, in Rust.
-
-[![Build Status][build-status-image]][build-status-url]
-[![Codecov][codecov-image]][codecov-url]
-[![Is-It-Maintained-Resolution-Time][iim-resolution-image]][iim-resolution-url]
-[![Is-It-Maintained-Open-Issues][iim-open-image]][iim-open-url]
-[![Crates.io][crates-io-image]][crates-io-url]
-[![Docs.rs][docs-image]][docs-url]
-[![License][license-image]][license-url]
-
-This is still pretty early, but seems to do the job. It needs a proper security review before you should consider using it for anything serious.
-
-Note that the API has changed since 0.0.8 . I released 0.0.9 by mistake.
-
-[build-status-image]: https://travis-ci.org/warner/spake2.rs.svg?branch=master
-[build-status-url]: https://travis-ci.org/warner/spake2.rs
-[codecov-image]: https://codecov.io/gh/warner/spake2.rs/branch/master/graph/badge.svg
-[codecov-url]: https://codecov.io/gh/warner/spake2.rs
-[crates-io-image]: https://img.shields.io/crates/v/spake2.svg
-[crates-io-url]: https://crates.io/crates/spake2
-[docs-image]: https://docs.rs/spake2/badge.svg
-[docs-url]: https://docs.rs/spake2
-[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
-[license-url]: LICENSE
-[iim-resolution-image]: http://isitmaintained.com/badge/resolution/warner/spake2.rs.svg
-[iim-resolution-url]: http://isitmaintained.com/project/warner/spake2.rs
-[iim-open-image]: http://isitmaintained.com/badge/open/warner/spake2.rs.svg
-[iim-open-url]: http://isitmaintained.com/project/warner/spake2.rs
+# 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
+security reviews.
+
+No efforts were yet taken in regards of [blinding][3] or erasing secrets from
+the memory.
+
+**USE AT YOUR OWN RISK.**
+
+## Supported algorithms
+
+| Name      | Crates.io  | Documentation  |
+| --------- |:----------:| :-----:|
+| [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
+
+ * [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
+ * [MIT license](http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
+dual licensed as above, without any additional terms or conditions.
+
+[1]: https://en.wikipedia.org/wiki/Password-authenticated_key_agreement
+[2]: https://en.wikipedia.org/wiki/Secure_Remote_Password_protocol
+[3]: https://en.wikipedia.org/wiki/Blinding_(cryptography)
+[4]: https://www.di.ens.fr/~mabdalla/papers/AbPo05a-letter.pdf