diff --git a/README.md b/README.md index 9ff4a51..5625843 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,15 @@ # godot-ci Docker image to deploy Godot Engine games -## Usage example -A `.gitlab-ci.yml` is included in this project as a usage example. - -##### Docker Hub +## Docker Hub https://hub.docker.com/r/barichello/godot-ci/ + +## Usage example +A `.gitlab-ci.yml` is included in this project as a usage example.
+After adapting the paths and names according to your project needs you will need the following **Variable** set in GitLab for this image to work: + +|Variable|Description|Example| +|-|-|-| +|$REMOTE_URL | The `git remote` where the web export will be hosted (in this case GitHub), it should contain your [deploy/personal access token](https://github.com/settings/tokens)|`https://:@github.com//.git` + +Others variables are set automatically by the `gitlab-runner`