From fe720d84f1465f286342723c23d746e2b394d7bb Mon Sep 17 00:00:00 2001
From: clabby <ben@clab.by>
Date: Fri, 24 Nov 2023 13:35:12 -0500
Subject: [PATCH] =?UTF-8?q?=E2=99=BB=20Clean?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 Cargo.toml               |  4 +--
 README.md                | 54 ++++++++++++++++++++++++++++++++--------
 crates/common/README.md  |  4 ++-
 crates/common/src/lib.rs |  2 ++
 4 files changed, 50 insertions(+), 14 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index 3b468e972..5c9a1b5bd 100644
--- a/Cargo.toml
+++ b/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]
diff --git a/README.md b/README.md
index 4395ac155..865f97c8d 100644
--- a/README.md
+++ b/README.md
@@ -7,20 +7,52 @@
 </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`*
+
+[op-program]: https://github.com/ethereum-optimism/optimism/tree/develop/op-program
+[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
diff --git a/crates/common/README.md b/crates/common/README.md
index 39db55ab0..f6849c03a 100644
--- a/crates/common/README.md
+++ b/crates/common/README.md
@@ -1 +1,3 @@
-# common
\ No newline at end of file
+# `kona-common`
+
+*TODO*
diff --git a/crates/common/src/lib.rs b/crates/common/src/lib.rs
index 42af06582..fcbe40466 100644
--- a/crates/common/src/lib.rs
+++ b/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