From 0c19d2a89889fdf01d22bd02402086b084b91083 Mon Sep 17 00:00:00 2001
From: skaunov <skaunov@disroot.org>
Date: Thu, 15 Feb 2024 03:32:05 +0300
Subject: [PATCH] current progress

---
 rust-arkworks/README.MD  |  3 +++
 rust-arkworks/src/lib.rs |  2 +-
 rust-k256/README.MD      |  1 +
 rust-k256/src/lib.rs     | 14 +++++++++++++-
 4 files changed, 18 insertions(+), 2 deletions(-)
 create mode 100644 rust-arkworks/README.MD
 create mode 100644 rust-k256/README.MD

diff --git a/rust-arkworks/README.MD b/rust-arkworks/README.MD
new file mode 100644
index 0000000..51d111c
--- /dev/null
+++ b/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.
\ No newline at end of file
diff --git a/rust-arkworks/src/lib.rs b/rust-arkworks/src/lib.rs
index f28bf4e..2497515 100644
--- a/rust-arkworks/src/lib.rs
+++ b/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;
diff --git a/rust-k256/README.MD b/rust-k256/README.MD
new file mode 100644
index 0000000..ff91c89
--- /dev/null
+++ b/rust-k256/README.MD
@@ -0,0 +1 @@
+https://github.com/plume-sig/zk-nullifier-sig/blob/main/README.md
\ No newline at end of file
diff --git a/rust-k256/src/lib.rs b/rust-k256/src/lib.rs
index 79e0fdc..8e78c2a 100644
--- a/rust-k256/src/lib.rs
+++ b/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,