Skip to content

Commit

Permalink
Improve docs (#849)
Browse files Browse the repository at this point in the history
* add usage section for lambdaworks-math

* add docs for crypto crate

* add crates to introduction
  • Loading branch information
juanbono authored Mar 26, 2024
1 parent ac71258 commit 0cd3ef5
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 4 deletions.
18 changes: 16 additions & 2 deletions crypto/README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
6 changes: 6 additions & 0 deletions docs/src/introduction.md
Original file line number Diff line number Diff line change
@@ -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)
16 changes: 14 additions & 2 deletions math/README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down

0 comments on commit 0cd3ef5

Please sign in to comment.