diff --git a/README.md b/README.md index e8bff1c9c..9ad483b3b 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@
@@ -19,35 +19,24 @@
- What's Kona? • + What's Kona? • Overview • - Credits • - Book • - Contributing + Contributing • + Credits
## What's Kona? -Kona is a [fault proof program] designed to execute a rollup state transition and ultimately verify an [L2 output root][g-output-root] from -L1 inputs, derived through the rollup's [derivation pipeline][g-derivation-pipeline]. +Kona is a [fault proof program][fpp-specs] designed to deterministically execute a rollup state transition in order to +verify an [L2 output root][g-output-root] from the L1 inputs it was [derived from][g-derivation-pipeline]. ## Overview -*TODO - overview after mockup* - -``` -crates -├── `common`: A suite of utilities for developing `client` programs to be ran on top of Fault Proof VMs. -└── `placeholder`: Placeholder -``` +* `common`: A suite of utilities for developing `client` programs to be ran on top of Fault Proof VMs. ## Book -The [book][book] contains a more in-depth overview of the project, tutorials for getting started with building your own programs, and a reference for the libraries and tools provided by Kona. - -## Contributing - -*TODO - write `CONTRIBUTING.md`* +The [book][book] contains a more in-depth overview of the project, contributor guidelines, tutorials for getting started with building your own programs, and a reference for the libraries and tools provided by Kona. ## Credits