chore: update README for 1.0 (#9540)

* start adding new benchmarks and recording

* add benchmarks

* add solady compilation benchmark

* crop demo gif to scale better

* clean up

* fix morpho-blue integration test, skewed because of create2 mining

* add compilation comparison for openzeppelin

* add very basic getting started

* add basic examples for each tool

* clean up

* clean up

* use default MIT and Apache 2.0 licenses for auto-recognition by Github

* apply default format of license, using existing fields

* clean up, point to book as primary source rather than crates

* clean up dev docs

* spell fix

* clean up

* nits

* nits

* revert to previous license version, updated format was not necessary - possibly Github related data issue yesterday

* Apply suggestions from code review

Co-authored-by: DaniPopes <[email protected]>

* note dual support

* fix link to actions

Co-authored-by: Lubov66 <[email protected]>

* link directly to existing references rather than overviews

* add designed benchmarks

* improve size slightly

* use center alignment

* fix spacing

* fix spacing

* update image paths

* remove outdated Foundry docs, users should refer to the book

* remove outdated docs, Foundry book should serve as primary source until we actually focus on Foundry as a library

* move demo.gif, remove unused logo

* fix build

* update table in fmt, restore docs for crate

* try fixing rpc that is down

---------

Co-authored-by: DaniPopes <[email protected]>
Co-authored-by: Lubov66 <[email protected]>

Author: 3 people

.github/assets/banner.png

@@ -184,4 +184,4 @@
       comment syntax for the file format. We also recommend that a
       file or class name and description of purpose be included on the
       same "printed page" as the copyright notice for easier
-      identification within third-party archives.
+      identification within third-party archives.

.github/assets/build_benchmark_openzeppelin_dark.png

@@ -16,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

.github/assets/build_benchmark_openzeppelin_light.png

@@ -1,4 +1,5 @@
-#![doc = include_str!("../README.md")]
+//! Anvil is a fast local Ethereum development node.
+
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
 use crate::{

.github/assets/build_benchmark_solady_dark.png

@@ -16,7 +16,7 @@ use foundry_common::{
 };
 use std::{path::PathBuf, str::FromStr};
 
-/// Perform Ethereum RPC calls from the comfort of your command line.
+/// A Swiss Army knife for interacting with Ethereum applications from the command line.
 #[derive(Parser)]
 #[command(
     name = "cast",

.github/assets/build_benchmark_solady_light.png

@@ -1,4 +1,5 @@
-#![doc = include_str!("../README.md")]
+//! Cast is a Swiss Army knife for interacting with Ethereum applications from the command line.
+
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
 use alloy_consensus::TxEnvelope;

.github/assets/demo.gif

@@ -37,7 +37,7 @@ Build Profile: [..]
 // tests `--help` is printed to std out
 casttest!(print_help, |_prj, cmd| {
     cmd.arg("--help").assert_success().stdout_eq(str![[r#"
-Perform Ethereum RPC calls from the comfort of your command line
+A Swiss Army knife for interacting with Ethereum applications from the command line
 
 Usage: cast[..] <COMMAND>
 

.github/demo.gif

@@ -1,4 +1,5 @@
-#![doc = include_str!("../README.md")]
+//! Cheatcode specification for Foundry.
+
 #![cfg_attr(not(test), warn(unused_crate_dependencies))]
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 

.github/logo.png

@@ -23,7 +23,6 @@ path = "bin/main.rs"
 [dependencies]
 # forge
 forge-fmt.workspace = true
-foundry-block-explorers.workspace = true
 foundry-cli.workspace = true
 foundry-common.workspace = true
 foundry-compilers = { workspace = true, features = ["project-util", "full"] }
@@ -38,7 +37,6 @@ alloy-primitives = { workspace = true, features = [
     "rlp",
 ] }
 alloy-json-abi.workspace = true
-alloy-rpc-types.workspace = true
 
 clap = { version = "4", features = ["derive", "env", "wrap_help"] }
 dirs = "5"