readme

Cargo.toml

@@ -14,5 +14,5 @@ quote = "1"
 syn = { version = "2", features = ["parsing", "full", "extra-traits"] }
 
 [[example]]
-name = "gen_mock_wat"
+name = "generate_mock_wat"
 path = "util/generate_mock_wat.rs"

README.md

@@ -0,0 +1,21 @@
+# Candid Extractor
+
+This project provides a CLI tool `candid_extractor` which extract candid definition from a canister WASM module.
+
+## Installation
+
+```
+cargo install --git https://github.com/lwshang/candid_extractor
+```
+
+## Usage
+
+```
+candid_extractor path/to/canister.wasm
+```
+
+## Generate IC mock wat
+
+```
+cargo run --example=generate_mock_wat
+```