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

Updated CHANGELOG; added stable/beta instructions to README

Browse source
This commit is contained in:
Michael Rosenberg 2022-12-12 02:54:25 -05:00
parent 6f237a0810
commit f38d677759
No known key found for this signature in database
2 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -16,6 +16,7 @@ major series.
* Update backend selection to be more automatic * Update backend selection to be more automatic
* Remove `std` feature flag * Remove `std` feature flag
* Remove `nightly` feature flag * Remove `nightly` feature flag
* Replace methods `Scalar::{zero, one}` with constants `Scalar::{ZERO, ONE}`
* Deprecate `EdwardsPoint::hash_from_bytes` and rename it `EdwardsPoint::nonspec_map_to_curve` * Deprecate `EdwardsPoint::hash_from_bytes` and rename it `EdwardsPoint::nonspec_map_to_curve`
* Require including a new trait, `use curve25519_dalek::traits::BasepointTable` * Require including a new trait, `use curve25519_dalek::traits::BasepointTable`
whenever using `EdwardsBasepointTable` or `RistrettoBasepointTable` whenever using `EdwardsBasepointTable` or `RistrettoBasepointTable`

15
README.md
View file

@ -30,10 +30,20 @@ cofactor-related abstraction mismatches.
# Use # Use
## Stable
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 = "4" curve25519-dalek = "3"
```
## Beta
To use the latest prerelease (see changes [below](#breaking-changes-in-400)),
use the following line in your project's `Cargo.toml`:
```toml
curve25519-dalek = "4.0.0-pre.3"
``` ```
## Feature Flags ## Feature Flags
@ -63,6 +73,9 @@ latest breaking changes are below:
* Update backend selection to be more automatic. See [backends](#backends) * Update backend selection to be more automatic. See [backends](#backends)
* Remove `std` feature flag * Remove `std` feature flag
* Remove `nightly` feature flag * Remove `nightly` feature flag
* Make `digest` an optional feature
* Make `rand_core` an optional feature
* Replace methods `Scalar::{zero, one}` with constants `Scalar::{ZERO, ONE}`
* Deprecate `EdwardsPoint::hash_from_bytes` and rename it * Deprecate `EdwardsPoint::hash_from_bytes` and rename it
`EdwardsPoint::nonspec_map_to_curve` `EdwardsPoint::nonspec_map_to_curve`
* Require including a new trait, `use curve25519_dalek::traits::BasepointTable` * Require including a new trait, `use curve25519_dalek::traits::BasepointTable`