readme

paradigmxyz · May 30, 2024 · a9022e4 · a9022e4
1 parent b687443
commit a9022e4
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,6 @@
-# eip3074-instructions
+# EIP3074 instructions
+
+[EIP-3074](https://eips.ethereum.org/EIPS/eip-3074) `AUTH` and `AUTHCALL` instructions.
+
+The implementation is located in the [instructions] module. The custom instruction
+context required for `AUTH` and `AUTHCALL` is located in the [context] module.
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,12 +1,4 @@
-//! # AlphaNet instructions
-//!
-//! Collection of custom opcodes for AlphaNet and related functionality.
-//!
-//! This currently implements the following EIPs:
-//! - [EIP-3074](https://eips.ethereum.org/EIPS/eip-3074): `AUTH` and `AUTHCALL` instructions. The
-//!   implementation is located in the [instructions] module. The custom instruction context required for
-//!   `AUTH` and `AUTHCALL` is located in the [context] module.
-
+#![doc = include_str!("../README.md")]
 #![cfg_attr(not(test), warn(unused_crate_dependencies))]
 
 use reth::revm::interpreter::opcode::BoxedInstruction;