From f38d677759cc69e6f389291ec99260e2ac6260d4 Mon Sep 17 00:00:00 2001 From: Michael Rosenberg Date: Mon, 12 Dec 2022 02:54:25 -0500 Subject: [PATCH] Updated CHANGELOG; added stable/beta instructions to README --- CHANGELOG.md | 1 + README.md | 15 ++++++++++++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cb1572d..83f91bc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,7 @@ major series. * Update backend selection to be more automatic * Remove `std` 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` * Require including a new trait, `use curve25519_dalek::traits::BasepointTable` whenever using `EdwardsBasepointTable` or `RistrettoBasepointTable` diff --git a/README.md b/README.md index c1d08e3..c078f39 100644 --- a/README.md +++ b/README.md @@ -30,10 +30,20 @@ cofactor-related abstraction mismatches. # Use +## Stable + To import `curve25519-dalek`, add the following to the dependencies section of your project's `Cargo.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 @@ -63,6 +73,9 @@ latest breaking changes are below: * Update backend selection to be more automatic. See [backends](#backends) * Remove `std` 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 `EdwardsPoint::nonspec_map_to_curve` * Require including a new trait, `use curve25519_dalek::traits::BasepointTable`