Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ross-spencer committed Aug 6, 2024
1 parent 73d567f commit d166dbf
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ network and client needs are better understood.

## Schema

<!--markdown-lint:disable-->
<!-- markdownlint-disable -->

* **pair**: pair as described in-code, e.g. for the slug needed to trigger validation
* **label**: presentation label, e.g. for Orcfax explorer
* **interval**: heartbeat, in seconds, integer
* **interval**: heartbeat, integer, in seconds, e.g. `3600` == `3600 seconds == 1 hour`
* **deviation**: percentage deviation to monitor, integer, ex. `1` == `1%`
* **source**: ( `cex` | `dex` )
* **calculation**: ( `median` | `weighted mean` )
* **status**: (`sponsored` | `subsidized` | `showcase`)
* **type**: (`CER` ) `CER` == `currencyExchangeRate`

<!--markdown-lint:enable-->
<!-- markdownlint-enable -->

Order of keys does not matter to JSON parsers, but it might provide important
visual cues to reviewers to maintain some consistency of ordering in this
Expand Down Expand Up @@ -49,3 +49,17 @@ should be updated with the anticipated calver number (`YYYY.MM.DD.NUMBER`) where
NUMBER represents the number of the release on a given day, e.g. if a feed is
updated twice in one day, the number will be `0002`. A tag should be created
and pushed for the version as part of publishing.

### Tagging

Tagging should be connected to feed changes, and so might look as follows:

* `git tag -a 2024.08.06.0001 -m "price feeds: 2024.08.06.0001"`

### Accessing versions

Access via:

* HEAD: `https://raw.githubusercontent.com/orcfax/price-feeds/main/feeds/price-feeds.json`
* Tagged: `https://raw.githubusercontent.com/orcfax/price-feeds/2024.08.06.0001/feeds/price-feeds.json`
* Commit: `https://raw.githubusercontent.com/orcfax/price-feeds/97940c30407da79a6389386b1e7ad9500e06cf50/feeds/price-feeds.json`

0 comments on commit d166dbf

Please sign in to comment.