Improve README (#40)

Author: davxy

README.md

@@ -1,11 +1,88 @@
-# Elliptic Curve VRFs
+# Elliptic Curve VRF-AD
 
-Provides:
-- IETF VRF as described by [RFC 9381](https://datatracker.ietf.org/doc/rfc9381).
-- Pedersen VRF as described by the first construction in [BCHSV23](https://eprint.iacr.org/2023/002).
-- Ring VRF as briefly described in [BCHSV23](https://eprint.iacr.org/2023/002) and formally specified [here](https://github.com/davxy/ring-proof-spec).
+This library provides flexible and efficient implementations of Verifiable
+Random Functions with Additional Data (VRF-AD), a cryptographic construct
+that augments a standard VRF scheme by incorporating auxiliary information
+into its signature.
 
-A formal yet quite lightweight specification of the schemes provided can be found [here](https://github.com/davxy/bandersnatch-vrfs-spec).
+It leverages the [Arkworks](https://github.com/arkworks-rs) framework and
+supports customization of scheme parameters.
 
-The implementation is built leveraging [Arkworks](https://github.com/arkworks-rs) libraries
-and is designed to be flexible for further customization.
+### Supported VRFs
+
+- **IETF VRF**: Complies with ECVRF described in [RFC9381](https://datatracker.ietf.org/doc/rfc9381).
+- **Pedersen VRF**: Described in [BCHSV23](https://eprint.iacr.org/2023/002).
+- **Ring VRF**: A zero-knowledge-based inspired by [BCHSV23](https://eprint.iacr.org/2023/002).
+
+### Schemes Specifications
+
+- [VRF Schemes Details](https://github.com/davxy/bandersnatch-vrfs-spec)
+- [Ring VRF ZK Proof](https://github.com/davxy/ring-proof-spec)
+
+### Basic Usage
+
+```rust
+let secret = Secret::from_seed(b"example seed");
+let public = secret.public();
+let input = Input::new(b"example input");
+let output = secret.output(input);
+let aux_data = b"optional aux data";
+```
+#### IETF-VRF
+
+Prove
+```rust
+use ark_ec_vrfs::ietf::Prover;
+let proof = secret.prove(input, output, aux_data);
+```
+
+Verify
+```rust
+use ark_ec_vrfs::ietf::Verifier;
+let result = public.verify(input, output, aux_data);
+```
+
+#### Ring-VRF
+
+Ring construction
+```rust
+const RING_SIZE: usize = 100;
+let prover_key_index = 3;
+// Construct an example ring with dummy keys
+let mut ring = (0..RING_SIZE).map(|i| Secret::from_seed(&i.to_le_bytes()).public().0).collect();
+// Patch the ring with the public key of the prover
+ring[prover_key_index] = public.0;
+// Any key can be replaced with the padding point
+ring[0] = RingContext::padding_point();
+```
+
+Ring context construction
+```rust
+let ring_ctx = RingContext::from_seed(RING_SIZE, b"example seed");
+```
+
+Prove
+```rust
+use ark_ec_vrfs::ring::Prover;
+let prover_key = ring_ctx.prover_key(&ring);
+let prover = ring_ctx.prover(prover_key, prover_key_index);
+let proof = secret.prove(input, output, aux_data, &prover);
+```
+
+Verify
+```rust
+use ark_ec_vrfs::ring::Verifier;
+let verifier_key = ring_ctx.verifier_key(&ring);
+let verifier = ring_ctx.verifier(verifier_key);
+let result = Public::verify(input, output, aux_data, &proof, &verifier);
+```
+
+Verifier key from commitment
+```rust
+let ring_commitment = ring_ctx.verifier_key().commitment();
+let verifier_key = ring_ctx.verifier_key_from_commitment(ring_commitment);
+```
+
+## License
+
+Distributed under the [MIT License](LICENSE).

src/lib.rs

@@ -1,15 +1,17 @@
 //! # Elliptic Curve VRFs.
 //!
-//! Provides:
-//! - IETF VRF as described by [RFC 9381](https://datatracker.ietf.org/doc/rfc9381).
-//! - Pedersen VRF as described by [Burdges](https://eprint.iacr.org/2023/002).
-//! - Ring VRF as described by [Vasilyev](https://eprint.iacr.org/2023/002).
+//! This library provides flexible and efficient implementations of Verifiable
+//! Random Functions with Additional Data (VRF-AD), a cryptographic construct
+//! that augments a standard VRF scheme by incorporating auxiliary information
+//! into its signature.
 //!
-//! Primitives description is further elaborated in the
-//! [technical spec](https://github.com/davxy/bandersnatch-vrfs-spec).
+//! It leverages the [Arkworks](https://github.com/arkworks-rs) framework and
+//! supports customization of scheme parameters.
 //!
-//! The implementation is built using Arkworks and is quite flexible to further
-//! customization.
+//! Supported VRFs:
+//! - **IETF VRF**: Complies with ECVRF described in [RFC9381](https://datatracker.ietf.org/doc/rfc9381).
+//! - **Pedersen VRF**: Described in [BCHSV23](https://eprint.iacr.org/2023/002).
+//! - **Ring VRF**: A zero-knowledge-based inspired by [BCHSV23](https://eprint.iacr.org/2023/002).
 
 #![cfg_attr(not(feature = "std"), no_std)]
 #![deny(unsafe_code)]