From 53b4ed3098d258385c0bdde5efbea58e30b923ad Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Wed, 14 Apr 2021 02:28:21 +0000 Subject: [PATCH] Update CHANGELOG and README for 4.x alpha. --- CHANGELOG.md | 5 +++++ README.md | 33 +++++++++++++++++++++++---------- src/lib.rs | 2 +- 3 files changed, 29 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1d42492..9314b27 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,11 @@ Entries are listed in reverse chronological order per undeprecated major series. +## 4.x series + +* Update the `rand_core` dependency version and the `rand` dev-dependency + version. + ## 3.x series ### 3.1.0 diff --git a/README.md b/README.md index 19679f9..44beaec 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,26 @@ make doc-internal To import `curve25519-dalek`, add the following to the dependencies section of your project's `Cargo.toml`: ```toml -curve25519-dalek = "3" +curve25519-dalek = "4.0.0-pre.0" ``` +## Major Version API Changes + +See `CHANGELOG.md` for more details. + +### 2.x + +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. + +### 3.x (current stable) + The sole breaking change in the `3.x` series was an update to the `digest` version, and in terms of non-breaking changes it includes: @@ -62,16 +79,12 @@ version, and in terms of non-breaking changes it includes: the Coq theorem proving system, and * support for explicitly calling the `zeroize` traits for all point types. -The `2.x` series has API almost entirely unchanged from the `1.x` series, -except that: +### 4.x (current alpha) -* 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. +The `4.x` series has an API largely unchanged from `3.x`, with a breaking change +to update the `rand` dependency crates. It also requires including a new trait, +`use curve25519_dalek::traits::BasepointTable`, whenever using `EdwardsBasepointTable` +or `RistrettoBasepointTable`. # Backends and Features diff --git a/src/lib.rs b/src/lib.rs index 13f9393..99d7192 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -22,7 +22,7 @@ #![cfg_attr(feature = "nightly", doc(include = "../README.md"))] #![doc(html_logo_url = "https://doc.dalek.rs/assets/dalek-logo-clear.png")] -#![doc(html_root_url = "https://docs.rs/curve25519-dalek/3.1.0")] +#![doc(html_root_url = "https://docs.rs/curve25519-dalek/4.0.0-pre.0")] //! Note that docs will only build on nightly Rust until //! [RFC 1990 stabilizes](https://github.com/rust-lang/rust/issues/44732).