From 1bd18de291731ccc02e25b7925810599003f1ef9 Mon Sep 17 00:00:00 2001 From: Henry de Valence Date: Fri, 25 Oct 2019 16:03:31 -0700 Subject: [PATCH] Add note on 2.x breaking changes. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 2eb08c0..df534c7 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,18 @@ your project's `Cargo.toml`: curve25519-dalek = "2" ``` +The `2.x` series has API almost entirely unchanged from the `1.x` series, +except that: + +* an error in the data modeling for the (optional) `serde` feature was + corrected, so that when the `2.x`-series `serde` implementation is used + with `serde-bincode`, the derived serialization matches the usual X/Ed25519 + formats; + +* the `rand` version was updated. + +See `CHANGELOG.md` for more details. + # Backends and Features The `nightly` feature enables features available only when using a Rust nightly