mirror of
https://github.com/saymrwulf/risc0-curve25519-dalek-source.git
synced 2026-09-04 20:03:40 +00:00
Update CHANGELOG and README for 4.x alpha.
This commit is contained in:
parent
c52aeb6bec
commit
53b4ed3098
3 changed files with 29 additions and 11 deletions
|
|
@ -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
|
||||
|
|
|
|||
33
README.md
33
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
|
||||
|
||||
|
|
|
|||
|
|
@ -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).
|
||||
|
|
|
|||
Loading…
Reference in a new issue