chore: added readme

bin/kona-exex/Cargo.toml

@@ -10,6 +10,9 @@ keywords.workspace = true
 categories.workspace = true
 
 [dependencies]
+# Local Dependencies
+kona-providers = { path = "../../crates/kona-providers" }
+
 # Workspace
 eyre.workspace = true
 tokio = { workspace = true, features = ["rt-multi-thread", "macros"] }

bin/kona-exex/README.md

@@ -0,0 +1,18 @@
+<h1 align="center">
+    Kona Execution Extension
+</h1>
+
+> [!WARN]
+> This is a work in progress and is not yet ready for production use.
+
+`kona-exex` is a [Reth][reth] [Execution Extension][exex] that powers an [OP Stack][opstack]
+Rollup node leveraging the [`kona-derive`][kona] implementation of the
+[Optimism Derivation Pipeline][derivation] in Rust.
+
+<!-- Links -->
+
+[reth]: https://github.com/paradigmxyz/reth
+[kona]: https://github.com/ethereum-optimism/kona
+[exex]: https://www.paradigm.xyz/2024/05/reth-exex
+[opstack]: https://docs.optimism.io/
+[derivation]: https://docs.optimism.io/stack/protocol/derivation-pipeline

bin/kona-exex/src/main.rs

@@ -1,3 +1,9 @@
+#![doc = include_str!("../README.md")]
+#![doc(issue_tracker_base_url = "https://github.com/paradigmxyz/op-rs/issues/")]
+#![warn(missing_debug_implementations, missing_docs, rustdoc::all)]
+#![deny(unused_must_use, rust_2018_idioms)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
+
 use std::sync::Arc;
 
 use clap::Parser;