diff --git a/README.md b/README.md index 2125eda..a458be0 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,14 @@ as: Use setup-forgejo from source. +The [setup-forgejo](https://code.forgejo.org/actions/setup-forgejo) +repository is a [Forgejo +Action](https://forgejo.org/docs/v1.21/user/actions/) which is meant +to be used in workflows. However, it is implemented as shell scripts that +can also be used to create Forgejo instances and runners locally. This +is convenient for testing and the reason why it needs to be added to the PATH. +For instance, it is a dependency of the `actions/run.sh` script. + ```sh git clone https://code.forgejo.org/actions/setup-forgejo export PATH=$(pwd)/setup-forgejo:$PATH