Prepare v0.2.0

CHANGELOG.md

@@ -10,11 +10,17 @@ This project adheres to [semantic versioning](http://semver.org/spec/v2.0.0.html
 
 ## [Unreleased](https://github.com/bitfunk/action-runner-orchestrator/releases/latest)
 
-See [changeset](https://github.com/bitfunk/action-runner-orchestrator/compare/v0.1.0...main)
+See [changeset](https://github.com/bitfunk/action-runner-orchestrator/compare/v0.2.0...main)
+
+
+## [0.2.0](https://github.com/bitfunk/action-runner-orchestrator/releases/tag/v0.2.0)
+
+See [changeset](https://github.com/bitfunk/action-runner-orchestrator/compare/v0.1.0...v0.2.0)
 
 ### Added
 
 - Configuration file to split script from configuration
+- Documentation
 
 ### Changed
 

README.md

@@ -5,12 +5,20 @@
 
 [repository]: https://github.com/bitfunk/action-runner-orchestrator
 [issues]: https://github.com/bitfunk/action-runner-orchestrator/issues
+[releases]: https://github.com/bitfunk/action-runner-orchestrator/releases
 
 # GitHub Action Runner Orchestrator
 
-Kotlin script to manage GitHub Action Runners on self-hosted machines
+Kotlin script to manage GitHub Action Runners on self-hosted machines.
 
-Scripts have been developed against Kotlin 1.7.20
+[![Latest release](docs/src/assets/images/badge-release-latest.svg)][releases]
+[![License](docs/src/assets/images/badge-license.svg)](LICENSE)
+
+## About the project
+
+This script helps to manage GitHub action runners for multiple GitHub repositories.
+
+The script has been developed against Kotlin 1.7.20 and is using kotlin-shell and ktor.
 
 ## Getting started
 
@@ -19,7 +27,7 @@ system: `export GITHUB_ACTIONS_RUNNER_REGISTRATION_TOKEN={token}`
 
 ## Usage
 
-Create a `orchestrator_config.json` file following this example:
+Clone the project on your desired runner machine and create a `orchestrator_config.json` file following this example:
 
 ```json
 {
@@ -38,7 +46,7 @@ Create a `orchestrator_config.json` file following this example:
 }
 ```
 
-Add the desired *organization* and *repository names* that you want to orchestrate.
+Add the desired *organization* and *repository names* that you want to this machine to register to as GitHub runner.
 
 Then just run the orchestrator: `./run-orchestrator.sh`
 

docs/src/develop/badges.md

@@ -0,0 +1,33 @@
+# Badges
+
+## How To Create Badges
+
+We use [Shields.io](https://shields.io/) to generate Badges.
+Please use the [badge links section](#_badge_links) to document and update currently used badges.
+Open the links and download the svg files and place them in the projects `assets/images` folder or use `curl` instead.
+
+## Download Badges
+
+Simply use `curl` to download badges by providing the `url` and `filename`, that starts with `badge`.
+
+```bash
+curl "link" -s -o badge-filename
+```
+
+## Badge Links
+
+Latest release:
+
+```bash
+curl "https://img.shields.io/badge/Release-0.2.0-blueviolet.svg?style=flat"  -s -o badge-release-latest.svg
+```
+
+License:
+
+```bash
+curl "https://img.shields.io/badge/License-ISC-lightgrey.svg?style=flat" -s -o badge-license.svg
+```
+
+## License
+
+Shields is licensed under _Creative Commons Zero v1.0 Universal_ (as of 2022-02-23)