update readme to include a small bit of instructions.

This commit is contained in:
Lukas Scheuerle
2021-03-16 01:26:39 +01:00
committed by GitHub
parent 58d5eaad1c
commit 2f0807172e
+3 -1
View File
@@ -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.
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.