Update README and crate docs to state that this is a fork

Author: andiflabs

README.md

@@ -1,35 +1,17 @@
-# Zcash Rust crates
+Implementation of the primitives used in Zcash and Iron Fish.
 
-This repository contains a (work-in-progress) set of Rust crates for
-working with Zcash.
+This is a fork of the original [`librustzcash`][librustzcash] project from
+Zcash. The fork was created by the Iron Fish project to add performance
+improvements.
 
-## Security Warnings
+## Delta from upstream
 
-These libraries are currently under development and have not been fully-reviewed.
+These are the differences between this crate and the upstream
+[`librustzcash`][librustzcash]:
 
-## License
+* Changed the elliptic curve backend from [`bls12_381`][bls12_381] to
+  [`blstrs`][blstrs]
 
-All code in this workspace is licensed under either of
-
- * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
-
-at your option.
-
-Downstream code forks should note that some (but not all) of these crates
-and components depend on the 'orchard' crate, which is licensed under the
-[Bootstrap Open Source License](https://github.com/zcash/orchard/blob/main/LICENSE-BOSL).
-A license exception is provided allowing some derived works that are linked or
-combined with the 'orchard' crate to be copied or distributed under the original
-licenses (in this case MIT / Apache 2.0), provided that the included portions of
-the 'orchard' code remain subject to BOSL.
-See <https://github.com/zcash/orchard/blob/main/COPYING> for details of which
-derived works can make use of this exception, and the `README.md` files in
-subdirectories for which crates and components this applies to.
-
-### Contribution
-
-Unless you explicitly state otherwise, any contribution intentionally
-submitted for inclusion in the work by you, as defined in the Apache-2.0
-license, shall be dual licensed as above, without any additional terms or
-conditions.
+[librustzcash]: https://github.com/zcash/librustzcash
+[bls12_381]: https://crates.io/crates/bls12_381
+[blstrs]: https://crates.io/crates/blstrs

ironfish-primitives/src/lib.rs

@@ -1,11 +1,6 @@
-//! *General Zcash primitives.*
-//!
-//! `zcash_primitives` is a library that provides the core structs and functions necessary
-//! for working with Zcash.
+#![doc = include_str!("../../README.md")]
 
 #![cfg_attr(docsrs, feature(doc_cfg))]
-// Catch documentation errors caused by code changes.
-#![deny(rustdoc::broken_intra_doc_links)]
 // Temporary until we have addressed all Result<T, ()> cases.
 #![allow(clippy::result_unit_err)]
 

ironfish-proofs/src/lib.rs

@@ -1,11 +1,6 @@
-//! *Zcash circuits and proofs.*
-//!
-//! `zcash_proofs` contains the zk-SNARK circuits used by Zcash, and the APIs for creating
-//! and verifying proofs.
+#![doc = include_str!("../../README.md")]
 
 #![cfg_attr(docsrs, feature(doc_cfg))]
-// Catch documentation errors caused by code changes.
-#![deny(broken_intra_doc_links)]
 // Temporary until we have addressed all Result<T, ()> cases.
 #![allow(clippy::result_unit_err)]