From 0cd3ef57b3c0807316d42c20374ca59ed45df187 Mon Sep 17 00:00:00 2001 From: Juan Bono Date: Tue, 26 Mar 2024 16:56:10 -0300 Subject: [PATCH] Improve docs (#849) * add usage section for lambdaworks-math * add docs for crypto crate * add crates to introduction --- crypto/README.md | 18 ++++++++++++++++-- docs/src/introduction.md | 6 ++++++ math/README.md | 16 ++++++++++++++-- 3 files changed, 36 insertions(+), 4 deletions(-) diff --git a/crypto/README.md b/crypto/README.md index 20f291d0b..5422833c1 100644 --- a/crypto/README.md +++ b/crypto/README.md @@ -1,6 +1,20 @@ -# lambdaworks Crypto +# lambdaworks-crypto [![Latest Version]][crates.io] -This folder contains different cryptographic primitives needed for proof systems. The main elements are: +[Latest Version]: https://img.shields.io/crates/v/lambdaworks-crypto.svg +[crates.io]: https://crates.io/crates/lambdaworks-crypto + + +## Usage + +Add this to your `Cargo.toml` +```toml +[dependencies] +lambdaworks-crypto = "0.5.0" +``` + +## Structure + +This crate contains different cryptographic primitives needed for proof systems. The main elements are: - [Merkle trees](https://github.com/lambdaclass/lambdaworks/tree/main/crypto/src/merkle_tree) - [Hash functions](https://github.com/lambdaclass/lambdaworks/tree/main/crypto/src/hash) - [Fiat Shamir transformation](https://github.com/lambdaclass/lambdaworks/tree/main/crypto/src/fiat_shamir) diff --git a/docs/src/introduction.md b/docs/src/introduction.md index 651a8dc63..522db22da 100644 --- a/docs/src/introduction.md +++ b/docs/src/introduction.md @@ -1,3 +1,9 @@ # Introduction This site hosts the main documentation for Lambdaworks as a whole. It is still a work in progress. + +## Crates + +- [lambdaworks-math](https://crates.io/crates/lambdaworks-math) +- [lambdaworks-crypto](https://crates.io/crates/lambdaworks-crypto) +- [lambdaworks-gpu](https://crates.io/crates/lambdaworks-gpu) diff --git a/math/README.md b/math/README.md index cc3810bc4..bd69d729b 100644 --- a/math/README.md +++ b/math/README.md @@ -1,6 +1,18 @@ -# lambdaworks Math +# lambdaworks-math [![Latest Version]][crates.io] -This folder contains all the relevant mathematical building blocks needed for proof systems and cryptography. The main parts are: +[Latest Version]: https://img.shields.io/crates/v/lambdaworks-math.svg +[crates.io]: https://crates.io/crates/lambdaworks-math + + +## Usage +Add this to your `Cargo.toml` +```toml +[dependencies] +lambdaworks-math = "0.5.0" +``` + +## Structure +This crate contains all the relevant mathematical building blocks needed for proof systems and cryptography. The main parts are: - [Finite Fields](https://github.com/lambdaclass/lambdaworks/tree/main/math/src/field) - [Elliptic curves](https://github.com/lambdaclass/lambdaworks/tree/main/math/src/elliptic_curve) - [Polynomials - univariate and multivariate](https://github.com/lambdaclass/lambdaworks/tree/main/math/src/polynomial)