Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
rm telegram ref
  • Loading branch information
clabby committed Sep 23, 2024
1 parent 3253e1c commit 266455c
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,16 @@ the block execution logic.
Built on top of these libraries, this repository also features a [fault proof program][fpp-specs] designed to deterministically execute the
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].

### Alternative Backends

Kona's libraries were built with alternative backend support and extensibility in mind - it is not just a fault proof
program! Kona is also used by:

- [`op-succinct`][op-succinct]

To build your own backend for kona, or build a new application on top of its libraries,
see the [SDK section of the book](https://anton-rs.github.io/kona/sdk/intro.html).

### Development Status

`kona` is currently in active development, and is not yet ready for use in production.
Expand Down Expand Up @@ -70,6 +80,7 @@ The [book][book] contains a more in-depth overview of the project, contributor g
[asterisc]: https://github.com/etheruem-optimism/asterisc
[fpp-specs]: https://specs.optimism.io/experimental/fault-proof/index.html
[book]: https://anton-rs.github.io/kona/
[op-succinct]: https://github.com/succinctlabs/op-succinct
[op-labs]: https://github.com/ethereum-optimism
[bad-boi-labs]: https://github.com/BadBoiLabs
[g-output-root]: https://specs.optimism.io/glossary.html#l2-output-root
Expand Down
2 changes: 1 addition & 1 deletion book/src/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contributing

Thank you for wanting to contribute! Before contributing to this repository, please read through this document and
discuss the change you wish to make via issue or in the development telegram.
discuss the change you wish to make via issue.

## Dependencies

Expand Down
4 changes: 2 additions & 2 deletions book/src/sdk/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ and developer empowerment.
## A Foundation of Flexibility

The kona repository is more than a fault proof program for the OP Stack — it's an ecosystem of interoperable components,
each crafted with reusability and extensibility as primary goals. While we provide a robust
{{#template ../../templates/glossary-link.md root=./ ref=fault-proof-vm text=Fault Proof VM}} and a "online" backend
each crafted with reusability and extensibility as primary goals. While we provide
{{#template ../../templates/glossary-link.md root=./ ref=fault-proof-vm text=Fault Proof VM}} and "online" backends
for key components like `kona-derive` and `kona-executor`, the true power of `kona` lies in its adaptability.

## Extend Without Forking
Expand Down

0 comments on commit 266455c

Please sign in to comment.