summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEarl Warren <contact@earl-warren.org>2023-05-30 12:47:12 +0200
committerEarl Warren <contact@earl-warren.org>2023-08-23 16:03:12 +0200
commit82385a944499d884fbb533b02113075d89e38549 (patch)
tree2852e736dddf1f8687b5d7be138dbd79279f5334 /README.md
parent[FORGEJO] README.md (diff)
downloadforgejo-runner-82385a944499d884fbb533b02113075d89e38549.tar.xz
forgejo-runner-82385a944499d884fbb533b02113075d89e38549.zip
[FORGEJO] branding
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index a82731e..8ecf2cd 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,12 @@
A daemon that connects to a Forgejo instance and runs jobs for continous integration. The high level [installation instructions](https://forgejo.org/docs/next/admin/actions/) are part of the Forgejo documentation.
+# Configuration
+
+Display the usage with `forgejo-runner --help`.
+
+For more information on the configuration file, see the [commented example](internal/pkg/config/config.example.yaml).
+
# Hacking
The Forgejo runner depends on [a fork of ACT](https://code.forgejo.org/forgejo/act) and is a dependency of the [setup-forgejo action](https://code.forgejo.org/actions/setup-forgejo). Together they provide a development environment with end to end testing. Each repository also has some unit testing that can be used to quickly detect the simplest mistakes such as a failure to compile or static code checking failures (vulnerability, lint, etc.).