Update README.md

README.md

@@ -8,61 +8,100 @@ A random assortment of Rust helper scripts.
 
 feel free to check out <https://github.com/ursisterbtw/hash_hunter>, an Ethereum address generator that I wrote, while you wait for me to add more scripts :)
 
-### `src` currently contains a GitHub repository analyzer that can be used to get a quick "summary" of a repository.
+## Available Tools
 
-This Rust application fetches and analyzes data from a specified GitHub repository. It provides a summary of the repository's information, statistics, languages used, and key files.
+### 1. GitHub Repository Analyzer
+Located in `src/`, this tool provides a quick "summary" of a repository.
 
-## Features
+- Fetches repository information such as name, description, URL, stars, forks, and more
+- Retrieves repository statistics including open issues, watchers, network count, and size
+- Analyzes the languages used in the repository
+- Fetches content of key files like `README.md`, `LICENSE`, `Cargo.toml`, etc
+- Supports output in JSON or YAML format
+
+### 2. EVM RPC Health Checker
+Located in `crates/evm_rpc_health_checker/`, this tool monitors the health of Ethereum RPC endpoints.
+
+- Continuously checks RPC endpoint availability
+- Reports current block number when healthy
+- Automatic retry on failures
+- Easy to configure for different RPC endpoints
+
+### 3. Solana RPC Health Checker
+Located in `crates/sol_rpc_health_checker/`, this tool monitors the health of Solana RPC endpoints.
+
+- Continuously checks RPC endpoint availability
+- Reports current Solana version when healthy
+- Automatic retry on failures
+- Configurable commitment level
+- Easy to configure for different RPC endpoints
 
-- Fetches repository information such as name, description, URL, stars, forks, and more.
-- Retrieves repository statistics including open issues, watchers, network count, and size.
-- Analyzes the languages used in the repository.
-- Fetches content of key files like `README.md`, `LICENSE`, `Cargo.toml`, etc.
-- Supports output in JSON or YAML format.
 
 ## Usage
 
-### For a repository like `paradigmxyz/solar`, run
+### GitHub Repository Analyzer
 
 ```bash
+# For a repository like paradigmxyz/solar
 cargo run --release -- paradigmxyz/solar
-```
 
-### Or for local testing, you might want to try a smaller repo
-
-```bash
+# For local testing with a smaller repo
 cargo run --release -- ursisterbtw/pyrs-template
+
+# Verbose output
+cargo run --release -- paradigmxyz/solar --token <GITHUB_TOKEN>
+
+# For help
+cargo run --release -- --help
 ```
 
-### Verbose output
+### EVM RPC Health Checker
 
-```rust
-cargo run --release -- paradigmxyz/solar --token <GITHUB_TOKEN>
+```bash
+# Navigate to the health checker directory
+cd crates/evm_rpc_health_checker
+
+# Run the health checker
+cargo run --release
 ```
 
-### For help
+### Solana RPC Health Checker
 
 ```bash
-cargo run --release -- --help
+# Navigate to the health checker directory
+cd crates/sol_rpc_health_checker
+
+# Run the health checker
+cargo run --release
 ```
 
 ## Directory structure
 
-```rust
-repo-summarizer/
+```
+rs_helpers/
 ├── .github/
-│   └── workflows/
-│       ├── ci.yml
-│       └── release.yml
+│ └── workflows/
+│ ├── ci.yml
+│ └── release.yml
 ├── src/
-│   └── main.rs
+│ └── main.rs
+├── crates/
+│ ├── evm_rpc_health_checker/
+│ │ └── src/
+│ │ └── main.rs
+│ └── sol_rpc_health_checker/
+│ └── src/
+│ └── main.rs
 └── Cargo.toml
 ```
 
 ## TODO
 
 - [ ] Add more tests
 - [ ] Add more documentation
+- [ ] Add configuration file support for RPC health checkers
+- [ ] Add support for multiple RPC endpoints in health checkers
+- [ ] Add customizable polling intervals for health checkers
 
 ## Contributing
 
@@ -72,10 +111,11 @@ repo-summarizer/
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
 
-
 ## Acknowledgments
 
 - [reqwest](https://github.com/seanmonstar/reqwest) for HTTP requests
 - [clap](https://github.com/clap-rs/clap) for command-line argument parsing
 - [indicatif](https://github.com/mitsuhiko/indicatif) for progress bars
 - [serde](https://github.com/serde-rs/serde) for serialization/deserialization
+- [ethers-rs](https://github.com/gakonst/ethers-rs) for Ethereum RPC interactions
+- [solana-sdk](https://github.com/solana-labs/solana) for Solana RPC interactions