Merge pull request #2 from zcash/release-0.1.0

Release 0.1.0
zcash · Dec 7, 2023 · 8683b1f · 8683b1f
2 parents 94aab28 + 717ec10
commit 8683b1f
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this library will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this library adheres to Rust's notion of
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2023-12-07
+Initial release.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "zcash_spec"
-version = "0.0.0"
+version = "0.1.0"
 authors = [
     "Jack Grigg <[email protected]>",
 ]

diff --git a/src/lib.rs b/src/lib.rs
@@ -1,3 +1,15 @@
+//! This crate provides low-level types for implementing Zcash specifications. When a
+//! common function defined in [the Zcash Protocol Specification] is used in multiple
+//! protocols (for example the Sapling and Orchard shielded protocols), a corresponding
+//! common type in this crate can be shared between implementations (for example by the
+//! [`sapling-crypto`] and [`orchard`] crates).
+//!
+//! [the Zcash Protocol Specification]: https://zips.z.cash/protocol/protocol.pdf
+//! [`sapling-crypto`]: https://crates.io/crates/sapling-crypto
+//! [`orchard`]: https://crates.io/crates/orchard
+
+#![no_std]
+#![deny(unsafe_code)]
 #![deny(rustdoc::broken_intra_doc_links)]
 
 mod prf_expand;

diff --git a/src/prf_expand.rs b/src/prf_expand.rs
@@ -1,4 +1,4 @@
-use std::marker::PhantomData;
+use core::marker::PhantomData;
 
 use blake2b_simd::Params;