current progress

rust-arkworks/README.MD

@@ -0,0 +1,3 @@
+https://github.com/plume-sig/zk-nullifier-sig/blob/main/README.md
+# HAZMAT
+Please note that until `v0.1.0` this is very much a preview crate which lets you have some preliminary feel of the structure and the reference implementation approach.

rust-arkworks/src/lib.rs

@@ -2,7 +2,7 @@
 ///
 /// See <https://blog.aayushg.com/nullifier> for more information.
 /// 
-/// Find RustCrypto crate as `plume_crypto`.
+/// Find RustCrypto crate as `plume_rustcrypto`.
 
 pub use crate::error::HashToCurveError;
 use crate::hash_to_curve::hash_to_curve;

rust-k256/README.MD

@@ -0,0 +1 @@
+https://github.com/plume-sig/zk-nullifier-sig/blob/main/README.md

rust-k256/src/lib.rs

@@ -5,7 +5,19 @@
 //!
 //! See <https://blog.aayushg.com/nullifier> for more information.
 //!
-//! Find `arkworks-rs` crate as `plume_arkworks`.
+// Find `arkworks-rs` crate as `plume_arkworks`.
+//
+// # Examples
+// For V2 just set `v1` to `None`
+// ```rust
+// # fn main() {
+//     let sig_good = PlumeSignature<'a>{
+//         message: &b"An example app message string",
+//         pk: ProjectivePoint::GENERATOR * Scalar::from_repr(hex!("519b423d715f8b581f4fa8ee59f4771a5b44c8130b4e3eacca54a56dda72b464").into()).unwrap(),
+//         ...
+//     };
+// # }
+// ```
 
 use k256::{
     elliptic_curve::ops::ReduceNonZero,