add readme

readme.md

@@ -0,0 +1,31 @@
+# yearn exporter
+
+collects on-chain numeric data about yearn vault and exposes it in prometheus format.
+
+point prometheus at this exporter persist the data and make it queryable.
+
+set up grafana for custom dashboards and alerts.
+
+
+## usage
+
+```
+brownie run yearn exporter --network mainnet
+```
+
+## supported vaults
+
+the goal of the project is to collect advanced metrics about vaults and strategies.
+if a strategy type is not marked here, only basic metrics are exposed.
+
+- [x] StrategyCurve*VoterProxy
+- [ ] StrategyVaultUSDC
+- [ ] StrategyDForceUSDC
+- [ ] StrategyCurveYCRVVoter
+- [ ] StrategyTUSDCurve
+- [ ] StrategyDAICurve
+- [ ] StrategyDForceUSDT
+- [ ] StrategyCreamYFI
+- [ ] StrategyCurveSBTC
+- [ ] StrategyMKRVaultDAIDelegate
+- [ ] CurveYCRVVoter