docs: add usage docs

availproject · Jan 4, 2024 · c471852 · c471852
1 parent 010d332
commit c471852
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -19,3 +19,11 @@ cargo run --profile maxperf
 # you can use RUSTFLAGS to use CPU-native optimizations:
 RUSTFLAGS="-C target-cpu=native" cargo run --profile maxperf
 ```
+
+## Usage
+* The bridge API operates on the 8080 port by default (can be configured).
+* To generate a proof, simply query the `/proof` endpoint with the block hash and extrinsic index like:
+```bash
+# curl "<endpoint URL>/proof/<blockhash>?index=<tx_index>"
+curl "http://localhost:8080/proof/0x021134e8a6c9eebefce062d19db3a0cbca0eacb8bd44d6a6cd19cc39d2e6c02b?index=2"
+```