diff --git a/README.md b/README.md index e78ef66..23006d9 100644 --- a/README.md +++ b/README.md @@ -25,11 +25,17 @@ [twitter-badge]: https://img.shields.io/twitter/url/https/twitter.com/SedaProtocol.svg?style=social&label=Follow%20%40SedaProtocol [twitter-url]: https://twitter.com/SedaProtocol -SEDA chain contracts written in CosmWasm. +SEDA chain core contract written in CosmWasm. To learn how to build a local version, please read [developing](DEVELOPING.md). To learn how to contribute, please read [contributing](CONTRIBUTING.md). +The core contract enables some of the core features of the SEDA protocol. It allows: +- Users to post data requests. +- Users can also stake to become executors allowing them to commit & reveal on data requests. +- The chain, via sudo functions, to timeout & remove data requests, while rewarding/burning funds for the later. +- Owner to transfer ownership, change configurations, and management of the allowlist. + ## Dependencies Before starting, make sure you have [rustup](https://rustup.rs/) along with a recent `rustc` and `cargo` version installed. Currently, we are testing on 1.70.0+. You need to have the `wasm32-unknown-unknown` target installed as well.