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.

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

Cosmetics changes to the readme. #681

Closed
wants to merge 13 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
115 changes: 115 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
{
"projectName": "stwo",
"projectOwner": "starkware-libs",
"repoType": "github",
"repoHost": "https://github.com",
"files": [
"README.md"
],
"imageSize": 100,
"commit": true,
"commitConvention": "gitmoji",
"contributors": [
{
"login": "spapinistarkware",
"name": "Shahar Papini",
"avatar_url": "https://avatars.githubusercontent.com/u/43779613?v=4",
"profile": "https://github.com/spapinistarkware",
"contributions": [
"code"
]
},
{
"login": "shaharsamocha",
"name": "shaharsamocha",
"avatar_url": "https://avatars.githubusercontent.com/u/18914050?v=4",
"profile": "https://github.com/shaharsamocha",
"contributions": [
"code"
]
},
{
"login": "andrewmilson",
"name": "Andrew Milson",
"avatar_url": "https://avatars.githubusercontent.com/u/6158251?v=4",
"profile": "https://github.com/andrewmilson",
"contributions": [
"code"
]
},
{
"login": "alonh5",
"name": "Alon Haramati",
"avatar_url": "https://avatars.githubusercontent.com/u/91828241?v=4",
"profile": "https://github.com/alonh5",
"contributions": [
"code"
]
},
{
"login": "ohad-starkware",
"name": "Ohad",
"avatar_url": "https://avatars.githubusercontent.com/u/137686240?v=4",
"profile": "https://github.com/ohad-starkware",
"contributions": [
"code"
]
},
{
"login": "alon-dotan-starkware",
"name": "alon-dotan-starkware",
"avatar_url": "https://avatars.githubusercontent.com/u/54667168?v=4",
"profile": "https://github.com/alon-dotan-starkware",
"contributions": [
"code"
]
},
{
"login": "weikengchen",
"name": "Weikeng Chen",
"avatar_url": "https://avatars.githubusercontent.com/u/14937807?v=4",
"profile": "https://www.chenweikeng.com/",
"contributions": [
"code"
]
},
{
"login": "suiwater",
"name": "water",
"avatar_url": "https://avatars.githubusercontent.com/u/161927344?v=4",
"profile": "https://github.com/suiwater",
"contributions": [
"code"
]
},
{
"login": "carlogf",
"name": "carlogf",
"avatar_url": "https://avatars.githubusercontent.com/u/24361728?v=4",
"profile": "https://github.com/carlogf",
"contributions": [
"code"
]
},
{
"login": "guyvelleman",
"name": "guy",
"avatar_url": "https://avatars.githubusercontent.com/u/93535692?v=4",
"profile": "https://github.com/guyvelleman",
"contributions": [
"code"
]
},
{
"login": "roi-amaler-starkware",
"name": "roi-amaler-starkware",
"avatar_url": "https://avatars.githubusercontent.com/u/72684158?v=4",
"profile": "https://github.com/roi-amaler-starkware",
"contributions": [
"code"
]
}
],
"contributorsPerLine": 7,
"linkToUsage": false
}
82 changes: 77 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,87 @@
<div align="center">

![STWO](resources/img/logo.png)

<a href="https://github.com/starkware-libs/stwo/actions/workflows/ci.yaml"><img alt="GitHub Workflow Status (with event)" src="https://img.shields.io/github/actions/workflow/status/starkware-libs/stwo/ci.yaml?style=for-the-badge" height=30></a>
<a href="https://codecov.io/gh/starkware-libs/stwo" >
<img src="https://img.shields.io/codecov/c/github/starkware-libs/stwo?style=for-the-badge&logo=codecov" height=30/>
</a>
<a href="https://github.com/starkware-libs/stwo/blob/main/LICENSE"><img src="https://img.shields.io/github/license/starkware-libs/stwo.svg?style=for-the-badge" alt="Project license" height="30"></a>
<a href="https://starkware.co/"><img src="https://img.shields.io/badge/By StarkWare-29296E.svg?&style=for-the-badge&logo=data:image/svg%2bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48c3ZnIGlkPSJhIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxODEgMTgxIj48ZGVmcz48c3R5bGU+LmJ7ZmlsbDojZmZmO308L3N0eWxlPjwvZGVmcz48cGF0aCBjbGFzcz0iYiIgZD0iTTE3Ni43Niw4OC4xOGwtMzYtMzcuNDNjLTEuMzMtMS40OC0zLjQxLTIuMDQtNS4zMS0xLjQybC0xMC42MiwyLjk4LTEyLjk1LDMuNjNoLjc4YzUuMTQtNC41Nyw5LjktOS41NSwxNC4yNS0xNC44OSwxLjY4LTEuNjgsMS44MS0yLjcyLDAtNC4yN0w5Mi40NSwuNzZxLTEuOTQtMS4wNC00LjAxLC4xM2MtMTIuMDQsMTIuNDMtMjMuODMsMjQuNzQtMzYsMzcuNjktMS4yLDEuNDUtMS41LDMuNDQtLjc4LDUuMThsNC4yNywxNi41OGMwLDIuNzIsMS40Miw1LjU3LDIuMDcsOC4yOS00LjczLTUuNjEtOS43NC0xMC45Ny0xNS4wMi0xNi4wNi0xLjY4LTEuODEtMi41OS0xLjgxLTQuNCwwTDQuMzksODguMDVjLTEuNjgsMi4zMy0xLjgxLDIuMzMsMCw0LjUzbDM1Ljg3LDM3LjNjMS4zNiwxLjUzLDMuNSwyLjEsNS40NCwxLjQybDExLjQtMy4xMSwxMi45NS0zLjYzdi45MWMtNS4yOSw0LjE3LTEwLjIyLDguNzYtMTQuNzYsMTMuNzNxLTMuNjMsMi45OC0uNzgsNS4zMWwzMy40MSwzNC44NGMyLjIsMi4yLDIuOTgsMi4yLDUuMTgsMGwzNS40OC0zNy4xN2MxLjU5LTEuMzgsMi4xNi0zLjYsMS40Mi01LjU3LTEuNjgtNi4wOS0zLjI0LTEyLjMtNC43OS0xOC4zOS0uNzQtMi4yNy0xLjIyLTQuNjItMS40Mi02Ljk5LDQuMyw1LjkzLDkuMDcsMTEuNTIsMTQuMjUsMTYuNzEsMS42OCwxLjY4LDIuNzIsMS42OCw0LjQsMGwzNC4zMi0zNS43NHExLjU1LTEuODEsMC00LjAxWm0tNzIuMjYsMTUuMTVjLTMuMTEtLjc4LTYuMDktMS41NS05LjE5LTIuNTktMS43OC0uMzQtMy42MSwuMy00Ljc5LDEuNjhsLTEyLjk1LDEzLjg2Yy0uNzYsLjg1LTEuNDUsMS43Ni0yLjA3LDIuNzJoLS42NWMxLjMtNS4zMSwyLjcyLTEwLjYyLDQuMDEtMTUuOGwxLjY4LTYuNzNjLjg0LTIuMTgsLjE1LTQuNjUtMS42OC02LjA5bC0xMi45NS0xNC4xMmMtLjY0LS40NS0xLjE0LTEuMDgtMS40Mi0xLjgxbDE5LjA0LDUuMTgsMi41OSwuNzhjMi4wNCwuNzYsNC4zMywuMTQsNS43LTEuNTVsMTIuOTUtMTQuMzhzLjc4LTEuMDQsMS42OC0xLjE3Yy0xLjgxLDYuNi0yLjk4LDE0LjEyLTUuNDQsMjAuNDYtMS4wOCwyLjk2LS4wOCw2LjI4LDIuNDYsOC4xNiw0LjI3LDQuMTQsOC4yOSw4LjU1LDEyLjk1LDEyLjk1LDAsMCwxLjMsLjkxLDEuNDIsMi4wN2wtMTMuMzQtMy42M1oiLz48L3N2Zz4=" alt="StarkWare" height="30"></a>
</div>

<div align="center">
<h3>
<a href="https://eprint.iacr.org/2024/278">
Paper
</a>
<span> | </span>
<a href="https://github.com/starkware-libs/stwo">
Documentation
</a>
<span> | </span>
<a href="https://starkware-libs.github.io/stwo/dev/bench/index.html">
Benchmarks
</a>
</h3>
</div>

# Stwo

## About
## 🌟 About

Stwo is a next generation implementation of a [CSTARK](https://eprint.iacr.org/2024/278) prover and verifier, written in Rust 🦀.

> **Stwo is a work in progress.**
>
> It is not recommended to use it in a production setting yet.

## 🚀 Key Features

Stwo is a Rust implementation of a [CSTARK](https://eprint.iacr.org/2024/278) prover and verifier.
- **Circle STARKs:** Based on the latest cryptographic research and innovations in the ZK field.
- **High performance:** Stwo is designed to be extremely fast and efficient.
- **Flexible:** Adaptable for various validity proof applications.

## Disclaimer
## 📊 Benchmarks

Stwo is a work in progress.
Benchmarks can be run using `cargo bench`.

## License
Visual representation of benchmarks can be found [here](https://starkware-libs.github.io/stwo/dev/bench/index.html).

## 📜 License

This project is licensed under the **Apache 2.0 license**.

See [LICENSE](LICENSE) for more information.

## ✨ Contributors

Thanks goes to these wonderful people:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/spapinistarkware"><img src="https://avatars.githubusercontent.com/u/43779613?v=4?s=100" width="100px;" alt="Shahar Papini"/><br /><sub><b>Shahar Papini</b></sub></a><br /><a href="https://github.com/starkware-libs/stwo/commits?author=spapinistarkware" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/shaharsamocha"><img src="https://avatars.githubusercontent.com/u/18914050?v=4?s=100" width="100px;" alt="shaharsamocha"/><br /><sub><b>shaharsamocha</b></sub></a><br /><a href="https://github.com/starkware-libs/stwo/commits?author=shaharsamocha" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/andrewmilson"><img src="https://avatars.githubusercontent.com/u/6158251?v=4?s=100" width="100px;" alt="Andrew Milson"/><br /><sub><b>Andrew Milson</b></sub></a><br /><a href="https://github.com/starkware-libs/stwo/commits?author=andrewmilson" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/alonh5"><img src="https://avatars.githubusercontent.com/u/91828241?v=4?s=100" width="100px;" alt="Alon Haramati"/><br /><sub><b>Alon Haramati</b></sub></a><br /><a href="https://github.com/starkware-libs/stwo/commits?author=alonh5" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/ohad-starkware"><img src="https://avatars.githubusercontent.com/u/137686240?v=4?s=100" width="100px;" alt="Ohad"/><br /><sub><b>Ohad</b></sub></a><br /><a href="https://github.com/starkware-libs/stwo/commits?author=ohad-starkware" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/alon-dotan-starkware"><img src="https://avatars.githubusercontent.com/u/54667168?v=4?s=100" width="100px;" alt="alon-dotan-starkware"/><br /><sub><b>alon-dotan-starkware</b></sub></a><br /><a href="https://github.com/starkware-libs/stwo/commits?author=alon-dotan-starkware" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://www.chenweikeng.com/"><img src="https://avatars.githubusercontent.com/u/14937807?v=4?s=100" width="100px;" alt="Weikeng Chen"/><br /><sub><b>Weikeng Chen</b></sub></a><br /><a href="https://github.com/starkware-libs/stwo/commits?author=weikengchen" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/suiwater"><img src="https://avatars.githubusercontent.com/u/161927344?v=4?s=100" width="100px;" alt="water"/><br /><sub><b>water</b></sub></a><br /><a href="https://github.com/starkware-libs/stwo/commits?author=suiwater" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/carlogf"><img src="https://avatars.githubusercontent.com/u/24361728?v=4?s=100" width="100px;" alt="carlogf"/><br /><sub><b>carlogf</b></sub></a><br /><a href="https://github.com/starkware-libs/stwo/commits?author=carlogf" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/guyvelleman"><img src="https://avatars.githubusercontent.com/u/93535692?v=4?s=100" width="100px;" alt="guy"/><br /><sub><b>guy</b></sub></a><br /><a href="https://github.com/starkware-libs/stwo/commits?author=guyvelleman" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/roi-amaler-starkware"><img src="https://avatars.githubusercontent.com/u/72684158?v=4?s=100" width="100px;" alt="roi-amaler-starkware"/><br /><sub><b>roi-amaler-starkware</b></sub></a><br /><a href="https://github.com/starkware-libs/stwo/commits?author=roi-amaler-starkware" title="Code">💻</a></td>
</tr>
</tbody>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->
Binary file added resources/img/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading