diff --git a/README.md b/README.md index 2de05b4..a746c26 100644 --- a/README.md +++ b/README.md @@ -32,3 +32,10 @@ It will read the contents of `config.yml` and begin its loop. You could also run ### Configuring In this repo, you can explore the `sample-config.yml` file for an example, but the general structure is as follows. It should be noted that environment variable interpolation happens on load of the YAML file. Also, when alerts are executed, they will be passed through Python's format function with arguments for some attributes of the Monitor. Currently this is limited to `{monitor_name}`. + +## Contributing + +Whether you're looking to submit a patch or just tell me I broke something, you can contribute through the Github mirror and I can merge PRs back to the source repository. + +Primary Repo: https://git.iamthefij.com/iamthefij/minitor.git +Github Mirror: https://github.com/IamTheFij/minitor.git