inital version

README.md

@@ -1 +1,35 @@
 # Gitea Runner Setup
+Deploys a gitea action runner for hosts.
+
+## state
+At this time only labels will be configerd. 
+Maybe if need i will add some more options later.
+
+## minimal setup
+### playbook
+```yaml
+- hosts: runner
+  roles:
+    - setup-gitea-runner
+```
+
+### vars
+#### host (recommend)
+``yaml
+RUNNER_TOKEN: '1234567890'
+RUNNER_LABELS:
+  - mylabel
+  - otherlabel
+```
+> Before register the runner and run it, you need a registration token. The level of the runner determines where to obtain the registration token.
+
+> Instance level: The admin settings page, like <your_gitea.com>/admin/actions/runners.
+> Organization level: The organization settings page, like <your_gitea.com>/<org>/settings/actions/runners.
+> Repository level: The repository settings page, like <your_gitea.com>/<owner>/<repo>/settings/actions/runners.
+
+#### group (recommend)
+```yaml
+RUNNER_INSTANCE: git.my-domain.com
+```
+
+For all vars look at [defaults](defaults/main.yml)!