Merge pull request #2 from zcash/release-0.1.0

Release 0.1.0

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.

Cargo.lock

@@ -33,7 +33,7 @@ checksum = "245097e9a4535ee1e3e3931fcfcd55a796a44c643e8596ff6566d68f09b87bbc"
 
 [[package]]
 name = "zcash_spec"
-version = "0.0.0"
+version = "0.1.0"
 dependencies = [
  "blake2b_simd",
 ]

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "zcash_spec"
-version = "0.0.0"
+version = "0.1.0"
 authors = [
     "Jack Grigg <jack@electriccoin.co>",
 ]

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;

src/prf_expand.rs

@@ -1,4 +1,4 @@
-use std::marker::PhantomData;
+use core::marker::PhantomData;
 
 use blake2b_simd::Params;