Skip to content

Commit

Permalink
WIP: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronFeickert committed Jan 16, 2024
1 parent 89c8a9a commit 1b3c53e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,16 @@ The implementation keeps dependencies to a minimum, and is `no_std` friendly.

There are several features that are enabled by default:
- `rand`: adds additional prover functionality that supplies a cryptographically-secure random number generator
- `serde`: adds proof serialization and deserialization
- `serde`: adds proof serialization and deserialization via `serde`
- `std`: adds corresponding dependency features

The underlying [curve library](https://crates.io/crates/curve25519-dalek) chooses an arithmetic backend based on CPU feature detection.
Using a nightly compiler broadens the backend set, and may provide better performance.
You can examine performance using the benchmarks: either `cargo bench` or `cargo +nightly bench`.

Proofs support a custom serialization format designed to be efficient and canonical.
This functionality has an associated fuzzer that can be run using a nightly compiler: `cargo +nightly fuzz run proofs`

## Warning

While this implementation is written with security in mind, it is currently **experimental** and not suitable for production use.
6 changes: 5 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,17 @@
//!
//! There are several features that are enabled by default:
//! - `rand`: adds additional prover functionality that supplies a cryptographically-secure random number generator
//! - `serde`: adds proof serialization and deserialization
//! - `serde`: adds proof serialization and deserialization via `serde`
//! - `std`: adds corresponding dependency features
//!
//! The underlying [curve library](https://crates.io/crates/curve25519-dalek) chooses an arithmetic backend based on CPU feature detection.
//! Using a nightly compiler broadens the backend set, and may provide better performance.
//! You can examine performance using the benchmarks: either `cargo bench` or `cargo +nightly bench`.
//!
//! Proofs support a custom serialization format designed to be efficient and canonical.
//! This functionality has an associated fuzzer that can be run using a nightly compiler: `cargo +nightly fuzz run
//! proofs`
//!
//! # Warning
//!
//! While this implementation is written with security in mind, it is currently **experimental** and not suitable for
Expand Down

0 comments on commit 1b3c53e

Please sign in to comment.