refactor : module name fix

HerodotusDev · Jan 29, 2024 · 757fcfd · 757fcfd
1 parent 8aa655d
commit 757fcfd
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 4 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,12 +1,12 @@
 [workspace]
 resolver = "2"
 members = [
-    "crates/cli",
+    "cli",
     "crates/decoder",
     "crates/evaluator",
     "crates/event-watcher",
     "crates/fetcher",
-    "crates/task-generator",
+    "crates/tasks-compiler",
     "crates/types",
 ]
 

diff --git a/README.md b/README.md
@@ -2,6 +2,29 @@
 
 [![CI](https://github.com/HerodotusDev/hdp/actions/workflows/ci.yml/badge.svg)](https://github.com/HerodotusDev/hdp/actions/workflows/ci.yml)
 
+## Quick Start
+
+```bash
+# install hdp
+cargo install --path cli
+
+# run herodotus data processing
+hdp --tasks 0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000018000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000060617667000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000006073756d00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000606d696e00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000606d6178000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000400000000000000000000000000000000000000000000000000000000000000000 --datalakes 0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000001600000000000000000000000000000000000000000000000000000000000000240000000000000000000000000000000000000000000000000000000000000032000000000000000000000000000000000000000000000000000000000000000c000000000000000000000000000000000000000000000000000000000009eb0f600000000000000000000000000000000000000000000000000000000009eb100000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000002010f00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000c000000000000000000000000000000000000000000000000000000000009eb0f600000000000000000000000000000000000000000000000000000000009eb100000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000002010f00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000c000000000000000000000000000000000000000000000000000000000009eb0f600000000000000000000000000000000000000000000000000000000009eb100000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000002010f00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000c000000000000000000000000000000000000000000000000000000000009eb0f600000000000000000000000000000000000000000000000000000000009eb100000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000002010f000000000000000000000000000000000000000000000000000000000000 --rpc-url=https://eth-goerli.g.alchemy.com/v2/wTjM2yJBF9bitPNwk5ZGvSkwIKWtuuqm
+```
+
+## CLI help
+
+```bash
+❯ hdp --help
+Usage: hdp [OPTIONS] --tasks <TASKS> --datalakes <DATA_LAKES>
+
+Options:
+  -t, --tasks <TASKS>           The tasks to process
+  -d, --datalakes <DATA_LAKES>  The data lakes to use
+  -r, --rpc-url <RPC_URL>       The RPC URL to use
+  -h, --help                    Print help
+```
+
 ## Main Workflow in `main.rs`
 
 - **`EventWatcher`**: Scrapes events from `HreExecutionStore.sol`.

diff --git a/crates/cli/Cargo.toml → cli/Cargo.toml b/crates/cli/Cargo.toml → cli/Cargo.toml
diff --git a/crates/cli/src/main.rs → cli/src/main.rs b/crates/cli/src/main.rs → cli/src/main.rs
diff --git a/crates/task-generator/Cargo.toml → crates/tasks-compiler/Cargo.toml b/crates/task-generator/Cargo.toml → crates/tasks-compiler/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "task-generator"
+name = "tasks-compiler"
 version = "0.1.0"
 edition = "2021"
 

diff --git a/crates/task-generator/src/lib.rs → crates/tasks-compiler/src/lib.rs b/crates/task-generator/src/lib.rs → crates/tasks-compiler/src/lib.rs