♻ Clean

Cargo.toml

@@ -7,8 +7,8 @@ version = "0.0.1"
 edition = "2021"
 license = "MIT"
 authors = ["clabby"]
-repository = "https://github.com/clabby/example"
-homepage = "https://github.com/clabby/example"
+repository = "https://github.com/anton-rs/kona"
+homepage = "https://github.com/anton-rs/kona"
 exclude = ["**/target", "benches/", "tests"]
 
 [workspace.dependencies]

README.md

@@ -7,20 +7,50 @@
 </h4>
 
 <p align="center">
-  <a href="https://github.com/clabby/brie/actions/workflows/ci.yaml">
-    <img src="https://github.com/clabby/brie/actions/workflows/ci.yaml/badge.svg?label=ci" alt="Ci">
+  <a href="https://github.com/anton-rs/kona/actions/workflows/ci.yaml">
+    <img src="https://github.com/anton-rs/kona/actions/workflows/ci.yaml/badge.svg?label=ci" alt="Ci">
   </a>
   <img src="https://img.shields.io/badge/License-MIT-green.svg?label=license" alt="License">
   <a href="https://github.com/ethereum-optimism/monorepo"><img src="https://img.shields.io/badge/OP%20Stack-monorepo-red" alt="OP Stack"></a>
   <a href="https://t.me/+2yfSX0YikWMxNTRh"><img src="https://img.shields.io/badge/Telegram-x?logo=telegram&label=anton-rs%20contributors"></a>
 </p>
 
-<!-- <p align="center"> -->
-<!--   <a href="#whats-a-cannon">What's a Cannon?</a> • -->
-<!--   <a href="#overview">Overview</a> • -->
-<!--   <a href="#credits">Credits</a> • -->
-<!--   <a href="#benchmarks">Benchmarks</a> • -->
-<!--   <a href="#contributing">Contributing</a> • -->
-<!--   <a href="#documentation">Documentation</a> • -->
-<!--   <a href="#docker">Docker</a> -->
-<!-- </p> -->
+<p align="center">
+  <a href="#whats-a-cannon">What's Kona?</a> •
+  <a href="#overview">Overview</a> •
+  <a href="#credits">Credits</a> •
+  <a href="#book">Book</a> •
+  <a href="#contributing">Contributing</a>
+</p>
+
+## What's Kona?
+
+Kona is a suite of libraries and build pipelines for developing verifiable Rust programs targeting Fault Proof VMs. Currently, Kona seeks to support the following targets:
+* [`cannon`][cannon] & [`cannon-rs`][cannon-rs]: A `MIPS32rel1` based Fault Proof VM.
+* [`asterisc`][asterisc]: A `RISC-V` based Fault Proof VM.
+
+This repository also contains a 
+
+## Overview
+
+*TODO*
+
+## Credits
+
+`kona` is inspired by the work of several other teams, namely [OP Labs][op-labs] and other contributors' work on the [`op-program`][op-program] and [BadBoiLabs][bad-boi-labs].
+
+## 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`*
+
+[cannon]: https://github.com/ethereum-optimism/optimism/tree/develop/cannon
+[cannon-rs]: https://github.com/anton-rs/cannon-rs
+[asterisc]: https://github.com/protolambda/asterisc
+[book]: https://anton-rs.github.io/kona/
+
+[op-labs]: https://github.com/ethereum-optimism
+[bad-boi-labs]: https://github.com/BadBoiLabs

crates/common/README.md

@@ -1 +1,3 @@
-# common
+# `kona-common`
+
+*TODO*

crates/common/src/lib.rs

@@ -7,3 +7,5 @@
 )]
 #![deny(unused_must_use, rust_2018_idioms)]
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
+// TODO