diff --git a/observability-lib/README.md b/observability-lib/README.md new file mode 100644 index 000000000..b06093fde --- /dev/null +++ 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 +```