diff --git a/README.md b/README.md index 2c625ff..9133834 100644 --- a/README.md +++ b/README.md @@ -127,11 +127,14 @@ Ticketing integration with GitHub can be configured with the following YAML in ` ```yaml tickets: github: - repo: github.com/your-org/SOC2 + repo: token: - username: org-bot-user + username: org or personal username ``` +If you're setting up the repo in your personal account, set `username` to your username. +If you're setting up the repo in an github organization, set `username` to your org's username instead. + Also, `GITHUB_REPO`, `GITHUB_TOKEN`, and `GITHUB_USERNAME` can be used to override values from the YAML file. ### Jira