diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3fad14291..d318b128d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,8 @@ ## Getting Started -To get started follow `Building from source` section of the `README.md` file. +To get started follow `Building from source` section of the [README](README.md) +file. ## Testing changes @@ -31,7 +32,7 @@ To update specific vendor package run manul manually: ## Running To build and start `unsee` from local branch see `Running` section of the -`README.md` file. +[README](README.md) file. When working with assets (templates, stylesheets and javascript files) `DEBUG` flag for make can be set, which will recompile binary assets in debug mode, diff --git a/LICENSE.md b/LICENSE similarity index 100% rename from LICENSE.md rename to LICENSE diff --git a/README.md b/README.md index 5a3b19883..938952831 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,8 @@ To clone git repo and build the binary yourself run: `unsee` is configured via environment variables or command line flags. Environment variable `ALERTMANAGER_URI` or cli flag `-alertmanager.uri` is the -only option required to run. See `Environment variables` section below for the -full list of supported environment variables. Examples: +only option required to run. See [Environment variables](#environment-variables) +section below for the full list of supported environment variables. Examples: ALERTMANAGER_URI=https://alertmanager.example.com unsee unsee -alertmanager.uri https://alertmanager.example.com @@ -255,3 +255,11 @@ This option can also be set using `-strip.labels` flag. Example: $ unsee -strip.labels "prometheus_instance alert_type" This variable is optional and default is not set (all labels will be shown). + +## Contributing + +Please see [CONTRIBUTING](/CONTRIBUTING.md) for details. + +## License + +Apache License 2.0, please see [LICENSE](/LICENSE).