Docs update (#51)

* update docs with running instructions * changelog * better changelog entry
canonical · Jun 26, 2023 · a3c5efb · a3c5efb
1 parent f5c51a1
commit a3c5efb
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+- Added usage instructions to the readme (#51).
+
 ## [0.4.0] - 2023-05-31
 
 ### Added

diff --git a/README.md b/README.md
@@ -36,9 +36,27 @@ route:
 ```
 Note that `group_wait` should be set to `0s` so the alert starts firing right away.
 
+## Configuring COS Alerter
 
-## Run COS Alerter
+Copy the file `cos_alerter/config-defaults.yaml` to `/etc/cos-alerter.yaml` (If running without docker) or `./cos-alerter` (if running with docker). Edit the file with the appropriate values for your environment.
 
-Coming soon...
+## Running COS Alerter
+
+### Docker
+
+The easiest way to run COS Alerter is to use docker.
+```
+docker run -p 8080:8080 --mount type=bind,source="$(pwd)"/cos-alerter.yaml,target=/etc/cos-alerter.yaml,readonly -it ghcr.io/canonical/cos-alerter:latest
+```
+
+### Python
+
+You can also run cos-alerter by installing the python package.
+```
+pip install cos-alerter
+cos-alerter
+```
+
+### Development Builds
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for running development builds.