Merge branch 'master' into develop

dalek-cryptography · Aug 18, 2020 · 1781dd3 · 1781dd3
2 parents 122d4bb + bddb3c7
commit 1781dd3
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,15 @@
 
 Entries are listed in reverse chronological order.
 
+## 1.0.0
+
+* Widen generic bound on `EphemeralSecret::new` and `StaticSecret::new` to
+  allow owned as well as borrowed RNGs.
+* Add `PublicKey::to_bytes` and `SharedSecret::to_bytes`, returning owned byte
+  arrays, complementing the existing `as_bytes` methods returning references.
+* Remove mention of deprecated `rand_os` crate from examples.
+* Clarify `EphemeralSecret`/`StaticSecret` distinction in documentation.
+
 ## 0.6.0
 
 * Updates `rand_core` version to `0.5`.

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,8 +1,11 @@
 [package]
 name = "x25519-dalek"
 edition = "2018"
-# Be sure to update the version in README.md
-version = "0.6.0"
+# Before changing this:
+# - update version in README.md
+# - update html_root_url
+# - update CHANGELOG
+version = "1.0.0"
 authors = [
     "Isis Lovecruft <isis@patternsinthevoid.net>", 
     "DebugSteven <debugsteven@gmail.com>",

diff --git a/README.md b/README.md
@@ -101,8 +101,8 @@ and load a long-term secret key.
 To install, add the following to your project's `Cargo.toml`:
 
 ```toml
-[dependencies.x25519-dalek]
-version = "0.6"
+[dependencies]
+x25519-dalek = "1"
 ```
 
 # Documentation

diff --git a/src/lib.rs b/src/lib.rs
@@ -20,6 +20,7 @@
 #![cfg_attr(feature = "nightly", deny(missing_docs))]
 #![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/x25519-dalek/1.0.0")]
 
 //! Note that docs will only build on nightly Rust until
 //! `feature(external_doc)` is stabilized.