Skip to content

Commit 0cd3ef5

Browse files
authored
Improve docs (#849)
* add usage section for lambdaworks-math * add docs for crypto crate * add crates to introduction
1 parent ac71258 commit 0cd3ef5

File tree

3 files changed

+36
-4
lines changed

3 files changed

+36
-4
lines changed

crypto/README.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,20 @@
1-
# lambdaworks Crypto
1+
# lambdaworks-crypto [![Latest Version]][crates.io]
22

3-
This folder contains different cryptographic primitives needed for proof systems. The main elements are:
3+
[Latest Version]: https://img.shields.io/crates/v/lambdaworks-crypto.svg
4+
[crates.io]: https://crates.io/crates/lambdaworks-crypto
5+
6+
7+
## Usage
8+
9+
Add this to your `Cargo.toml`
10+
```toml
11+
[dependencies]
12+
lambdaworks-crypto = "0.5.0"
13+
```
14+
15+
## Structure
16+
17+
This crate contains different cryptographic primitives needed for proof systems. The main elements are:
418
- [Merkle trees](https://github.com/lambdaclass/lambdaworks/tree/main/crypto/src/merkle_tree)
519
- [Hash functions](https://github.com/lambdaclass/lambdaworks/tree/main/crypto/src/hash)
620
- [Fiat Shamir transformation](https://github.com/lambdaclass/lambdaworks/tree/main/crypto/src/fiat_shamir)

docs/src/introduction.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
# Introduction
22

33
This site hosts the main documentation for Lambdaworks as a whole. It is still a work in progress.
4+
5+
## Crates
6+
7+
- [lambdaworks-math](https://crates.io/crates/lambdaworks-math)
8+
- [lambdaworks-crypto](https://crates.io/crates/lambdaworks-crypto)
9+
- [lambdaworks-gpu](https://crates.io/crates/lambdaworks-gpu)

math/README.md

+14-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,18 @@
1-
# lambdaworks Math
1+
# lambdaworks-math [![Latest Version]][crates.io]
22

3-
This folder contains all the relevant mathematical building blocks needed for proof systems and cryptography. The main parts are:
3+
[Latest Version]: https://img.shields.io/crates/v/lambdaworks-math.svg
4+
[crates.io]: https://crates.io/crates/lambdaworks-math
5+
6+
7+
## Usage
8+
Add this to your `Cargo.toml`
9+
```toml
10+
[dependencies]
11+
lambdaworks-math = "0.5.0"
12+
```
13+
14+
## Structure
15+
This crate contains all the relevant mathematical building blocks needed for proof systems and cryptography. The main parts are:
416
- [Finite Fields](https://github.com/lambdaclass/lambdaworks/tree/main/math/src/field)
517
- [Elliptic curves](https://github.com/lambdaclass/lambdaworks/tree/main/math/src/elliptic_curve)
618
- [Polynomials - univariate and multivariate](https://github.com/lambdaclass/lambdaworks/tree/main/math/src/polynomial)

0 commit comments

Comments
 (0)