saymrwulf/curve25519-dalek-source
1
0
Fork 0
mirror of https://github.com/saymrwulf/curve25519-dalek-source.git synced 2026-09-06 20:41:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update CHANGELOG and README for 4.x alpha.

Browse source
This commit is contained in:
Isis Lovecruft 2021-04-14 02:28:21 +00:00
parent c52aeb6bec
commit 53b4ed3098
No known key found for this signature in database
GPG key ID: AB41313533E8E812
3 changed files with 29 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CHANGELOG.md
View file

@ -3,6 +3,11 @@
Entries are listed in reverse chronological order per undeprecated Entries are listed in reverse chronological order per undeprecated
major series. major series.
## 4.x series
* Update the `rand_core` dependency version and the `rand` dev-dependency
version.
## 3.x series ## 3.x series
### 3.1.0 ### 3.1.0

33
README.md
View file

@ -45,9 +45,26 @@ make doc-internal
To import `curve25519-dalek`, add the following to the dependencies section of To import `curve25519-dalek`, add the following to the dependencies section of
your project's `Cargo.toml`: your project's `Cargo.toml`:
```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` 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: 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 the Coq theorem proving system, and
* support for explicitly calling the `zeroize` traits for all point types. * 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, ### 4.x (current alpha)
except that:
* an error in the data modeling for the (optional) `serde` feature was The `4.x` series has an API largely unchanged from `3.x`, with a breaking change
corrected, so that when the `2.x`-series `serde` implementation is used to update the `rand` dependency crates. It also requires including a new trait,
with `serde-bincode`, the derived serialization matches the usual X/Ed25519 `use curve25519_dalek::traits::BasepointTable`, whenever using `EdwardsBasepointTable`
formats; or `RistrettoBasepointTable`.
* the `rand` version was updated.
See `CHANGELOG.md` for more details.
# Backends and Features # Backends and Features

2
src/lib.rs
View file

@ -22,7 +22,7 @@
#![cfg_attr(feature = "nightly", doc(include = "../README.md"))] #![cfg_attr(feature = "nightly", doc(include = "../README.md"))]
#![doc(html_logo_url = "https://doc.dalek.rs/assets/dalek-logo-clear.png")] #![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 //! Note that docs will only build on nightly Rust until
//! [RFC 1990 stabilizes](https://github.com/rust-lang/rust/issues/44732). //! [RFC 1990 stabilizes](https://github.com/rust-lang/rust/issues/44732).