From 41678af862c7e22b7fbcd1fbdde92a7a5dbb5b87 Mon Sep 17 00:00:00 2001 From: Alex Mootz Date: Thu, 19 Oct 2023 16:05:36 -0400 Subject: [PATCH] chore: add readme to sep-40 package --- sep-40/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 sep-40/README.md diff --git a/sep-40/README.md b/sep-40/README.md new file mode 100644 index 0000000..e0f0f84 --- /dev/null +++ b/sep-40/README.md @@ -0,0 +1,20 @@ +# SEP-0040 Oracle +Exposes the interface of the SEP-0040 Price Feed Oracle alongside a test price oracle contract. + +SEP-0040 Definition: https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0040.md + +## Getting Started + +Add the package to your `Cargo.toml`: + +```toml +[dependencies] +sep-40-oracle = "" +``` + +You can optionally include the `testutils` feature in your `dev-dependencies` to deploy a mock version of the `sep-40-oracle` for testing: + +```toml +[dev_dependencies] +sep-40-oracle = { version = "", features = ["testutils"] } +```