docs: readme

succinctlabs · Sep 26, 2024 · 13d963c · 13d963c
1 parent cebfe00
commit 13d963c
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,20 @@
+# Solana Verifier
+
+A Groth16 verifier implementation for Solana using BN254 precompiles. This crate verifies Groth16 proofs generated with SP1, leveraging Solana's BN254 precompiles for efficient cryptographic operations.
+
+## Features
+
+- **Groth16 Proof Verification**: Implements the Groth16 protocol for zero-knowledge proof verification.
+- **Solana BN254 Precompiles**: Leverages Solana's native BN254 precompiles for optimized performance.
+- **Easy Integration**: Seamlessly integrates with existing Solana programs and infrastructure.
+- **Extensible**: Built with modularity in mind, allowing for future enhancements and integrations.
+
+## Installation
+
+Add `solana-verifier` to your `Cargo.toml`:
+
+```toml
+[dependencies]
+solana-verifier = { git = "https://github.com/0xWOLAND/groth16-verifier" }
+```
+
diff --git a/example/script/Cargo.lock b/example/script/Cargo.lock
diff --git a/example/script/Cargo.toml b/example/script/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "recursive-script"
+name = "example-usage"
 authors = ["Bhargav Annem"]
 version = "0.1.0"
 edition = "2021"