diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 000000000..34bb74995 --- /dev/null +++ b/.all-contributorsrc @@ -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 +} diff --git a/README.md b/README.md index 602df385b..153d55a1e 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,87 @@ +
+ +![STWO](resources/img/logo.png) + +GitHub Workflow Status (with event) + + + +Project license +StarkWare +
+ +
+

+ + Paper + + | + + Documentation + + | + + Benchmarks + +

+
+ # 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: + + + + + + + + + + + + + + + + + + + + + + +
Shahar Papini
Shahar Papini
💻		shaharsamocha
shaharsamocha
💻		Andrew Milson
Andrew Milson
💻		Alon Haramati
Alon Haramati
💻		Ohad
Ohad
💻		alon-dotan-starkware
alon-dotan-starkware
💻		Weikeng Chen
Weikeng Chen
💻
water
water
💻		carlogf
carlogf
💻		guy
guy
💻		roi-amaler-starkware
roi-amaler-starkware
💻
+ + + + + diff --git a/resources/img/logo.png b/resources/img/logo.png new file mode 100644 index 000000000..07d6055ee Binary files /dev/null and b/resources/img/logo.png differ