Browse Source

Add author/version to README, and a link to the main docs to the top-level module

Ian Goldberg 1 week ago
parent
commit
3eeb404335
2 changed files with 5 additions and 0 deletions
  1. 3 0
      README.md
  2. 2 0
      src/lib.rs

+ 3 - 0
README.md

@@ -1,3 +1,6 @@
+`sigma-compiler` by Ian Goldberg, iang@uwaterloo.ca  
+Version 0.1.0-rc1, 2025-09-16
+
 This crate provides the `sigma_compiler!` macro as an easy interface
 to the [`sigma-proofs`](https://crates.io/crates/sigma-proofs) API
 for non-interactive zero-knowledge sigma protocols.

+ 2 - 0
src/lib.rs

@@ -1,3 +1,5 @@
+//! See the documentation for [`sigma_compiler!`] for details.
+
 pub use group;
 pub use rand;
 pub use sigma_compiler_derive::{sigma_compiler, sigma_compiler_prover, sigma_compiler_verifier};