feat: update docs

Kava-Labs · Sep 25, 2024 · cbbf9ad · cbbf9ad
1 parent 55fec5f
commit cbbf9ad
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 8 deletions.
diff --git a/alerts/README.md b/alerts/README.md
@@ -54,4 +54,25 @@ AWS_PROFILE=development $GOPATH/bin/alerts usdx run
 
 ## Alerts
 
-There is a separate auction alerts service run that is described in the [doc](./auctions/README.md).
+### Auction
+
+Auction alerts tracks ongoing auctions on the Kava Chain and alerts for:
+
+- Total value of auctions above configured value
+- Percentage price deviation of auction clearing price above configured value
+
+Runs with:
+```bash
+go run . auctions run
+```
+
+### USDX
+
+USDX alerts tracks the USDX price on the Kava Chain and alerts for:
+
+- Price deviation of USDX below configured value
+
+Runs with:
+```bash
+go run . usdx run
+```
diff --git a/alerts/auctions/README.md b/alerts/auctions/README.md