diff --git a/README.md b/README.md index 5a7c602..c1b1ec2 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ Originally created and intended to be used for a more automated use of minecraft [File in this repository](https://github.com/Plagiatus/RCON-Action/blob/main/.github/workflows/main.yml) +Copy the linked example file under `your_repository/.github/workflow/main.yml`, update and add the [secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) to your repository and you're ready to go. That is if your server has both FTP and RCON enabled. + ```yml name: RCON Test @@ -42,4 +44,4 @@ jobs: | send-push-info | no | Whether a tellraw informing about the push should be sent | `true` | | | push-info-recipient | no | Changes the selector of the push info tellraw. | `@a` | `@a[tag=admin]` | -It is highly recommended to use [github secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) instead of plaintext inclusions for more sensitive data like the IP or the password. \ No newline at end of file +It is highly recommended to use [github secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) instead of plaintext inclusions for more sensitive data like the IP or the password.