Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve docs #849

Merged
merged 4 commits into from
Mar 26, 2024
Merged

Improve docs #849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b33212c
add usage section for lambdaworks-math
juanbono Mar 26, 2024
c22155d
add docs for crypto crate
juanbono Mar 26, 2024
7b6f7ec
add crates to introduction
juanbono Mar 26, 2024
c566d4c
Merge branch 'main' into add_crates_list_to_docs
juanbono Mar 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions crypto/README.md
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading