examples doc

calbera · Oct 25, 2024 · 43400a1 · 43400a1
1 parent 026af3e
commit 43400a1
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,19 @@
+# Examples
+
+This directory contains examples of how to use the Pyth client.
+
+## Lib
+
+The `lib` directory contains shared utilities for the examples.
+
+## Query
+
+The `query` directory contains examples of how to query Pyth using the `Hermes` and `Benchmarks` clients for the latest and historical prices, respectively. The returned price data can then be used in EVM contract transactions from the `lib.PriceUpdate` struct.
+
+### Example 1: Perpetuals
+
+Coming soon.
+
+### Example 2: Lending Markets
+
+Coming soon.