From 43400a132094ec29a3ea6d3b250c11baddcf062c Mon Sep 17 00:00:00 2001 From: Cal Bera Date: Fri, 25 Oct 2024 15:43:13 -0400 Subject: [PATCH] examples doc --- examples/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 examples/README.md diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..199177d --- /dev/null +++ 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.