Skip to content

Commit

Permalink
📝 Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
clabby committed Dec 20, 2023
1 parent 8cc4481 commit 2554126
Showing 1 changed file with 8 additions and 19 deletions.
27 changes: 8 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
</h1>

<h4 align="center">
A verifiable implementation of the [Optimism][op-stack] rollup state transition.
A verifiable implementation of the <a href="https://github.com/ethereum-optimism/optimism">Optimism</a> rollup state transition.
</h4>

<p align="center">
Expand All @@ -19,35 +19,24 @@
</p>

<p align="center">
<a href="#whats-a-cannon">What's Kona?</a> •
<a href="#whats-kona">What's Kona?</a> •
<a href="#overview">Overview</a> •
<a href="#credits">Credits</a> •
<a href="#book">Book</a> •
<a href="#contributing">Contributing</a>
<a href="#book">Contributing</a> •
<a href="#credits">Credits</a>
</p>

## 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

Expand Down

0 comments on commit 2554126

Please sign in to comment.