chore: add README

smartcontractkit · May 30, 2024 · d276b1f · d276b1f
1 parent bb9a6e0
commit d276b1f
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/observability-lib/README.md b/observability-lib/README.md
@@ -0,0 +1,28 @@
+## Observability-lib
+
+Contains the observability library to build dashboards and alerts
+
+## Usage
+
+To build the observability library, run the following command:
+
+```bash
+make build
+```
+
+To run the tests, run the following command:
+
+```bash
+make test
+```
+
+To run the linter, run the following command:
+
+```bash
+make lint
+```
+
+To run the CLI
+```bash
+make run
+```