From eb7202bbe2b5e0c5d9507a7342dd2f3bd9c3e40b Mon Sep 17 00:00:00 2001
From: sprites0 <199826320+sprites0@users.noreply.github.com>
Date: Sun, 6 Jul 2025 03:45:59 +0000
Subject: [PATCH] doc: Revise README

---
 README.md | 51 +++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 41 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 109350dde..590f677a9 100644
--- a/README.md
+++ b/README.md
@@ -3,14 +3,45 @@
 HyperEVM archive node implementation based on reth's NodeBuilder API.
 Heavily inspired by [reth-bsc](https://github.com/loocapro/reth-bsc).
 
-## TODOs
+## Installation
 
-- [x] Make it compilable
-  - [x] EVM
-  - [x] Storage
-  - [x] TX forwarder API
-- [x] Decide whether to include system txs, receipts in block or not
-- [x] Downloader
-  - [x] S3 format (file)
-  - [x] S3 format (AWS API)
-  - [x] hl-node format
+Install the `reth-hl` binary:
+
+```sh
+$ make install
+```
+
+## Usage
+
+### Ingest from S3
+
+Set AWS credentials in `~/.aws/credentials`. To use a non-default profile:
+
+```sh
+$ export AWS_PROFILE=default  # optional
+$ reth-hl node --s3 --http --ws --ws.port=8545
+```
+
+### Ingest from local
+
+#### S3-style directory (backfill):
+
+```sh
+$ reth-hl node --ingest-dir=/path/to/evm-blocks ...
+```
+
+#### Native hl-node format (realtime, low latency):
+
+```sh
+$ reth-hl node --local-ingest-dir=$HOME/hl/data/evm_blocks_and_receipts ...
+```
+
+Or if the path is `$HOME/hl/data/evm_blocks_and_receipts` simply:
+
+```sh
+$ reth-hl node --local
+```
+
+---
+
+**Note:** This is a draft and will be merged with `nanoreth` documentation.