Merge pull request #8 from ithacaxyz/klkvr/readme

chore: update README

.config/zepter.yaml

@@ -12,15 +12,13 @@ workflows:
         # Check that `A` activates the features of `B`.
         "propagate-feature",
         # These are the features to check:
-        "--features=std,serde,arbitrary",
+        "--features=std",
         # Do not try to add a new section into `[features]` of `A` only because `B` expose that feature. There are edge-cases where this is still needed, but we can add them manually.
         "--left-side-feature-missing=ignore",
         # Ignore the case that `A` it outside of the workspace. Otherwise it will report errors in external dependencies that we have no influence on.
-
         "--left-side-outside-workspace=ignore",
-        # Auxilary flags:
-        "--offline",
-        "--locked",
+        # limit to the workspace
+        "--workspace",
         "--show-path",
         "--quiet",
       ]
@@ -31,11 +29,10 @@ workflows:
 # Will be displayed when any workflow fails:
 help:
   text: |
-    Reth uses the Zepter CLI to detect abnormalities in Cargo features, e.g. missing propagation.
+    Alloy uses the Zepter CLI to detect abnormalities in Cargo features, e.g. missing propagation.
 
     It looks like one more checks failed; please check the console output.
 
     You can try to automatically address them by installing zepter (`cargo install zepter --locked`) and simply running `zepter` in the workspace root.
   links:
-    - "https://github.com/paradigmxyz/reth/pull/11888"
     - "https://github.com/ggwpez/zepter"

README.md

@@ -1,10 +1,12 @@
+# :construction: This repository is a work in progress.
+
 # Alloy-EVM
 
 ## Overview
 
-Contains EVM abstractions compatible with types from the alloy ecosystem.
-Comes with batteries included for block execution.
-Compatible with no_std and riscv targets.
+`alloy-evm` is an abstraction layer on top of [revm](https://github.com/bluealloy/revm) providing common implementations of EVMs. Currently, alloy-evm is only used in Reth but is designed to be consumed by any project that needs to execute/trace transactions or blocks on EVM compatible chains.
+
+`alloy-evm` is compatible with no_std and riscv targets.
 
 #### License
 

crates/op-evm/Cargo.toml

@@ -25,6 +25,7 @@ default = ["std"]
 std = [
 	"alloy-primitives/std",
 	"derive_more/std",
-	"revm/std"
+	"revm/std",
+	"alloy-evm/std"
 ]
 optimism = ["revm/optimism"]