From 5371b7c8a40a91338223e95f037ad07e786e3cd2 Mon Sep 17 00:00:00 2001
From: Darwin D Wu <darwin67@users.noreply.github.com>
Date: Thu, 21 Jul 2022 00:18:38 -0700
Subject: [PATCH] Update README to clarify github config attributes

---
 README.md | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

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: <repo-name>
     token: <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