From d6d12c3206150e684979923b500bbab9a7cd1577 Mon Sep 17 00:00:00 2001
From: Adam Shannon <adamkshannon@gmail.com>
Date: Thu, 26 Dec 2019 16:05:32 -0600
Subject: [PATCH] docs: add section for github ticketing config

Issue: https://github.com/strongdm/comply/issues/81
---
 README.md | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e253243..4a0b89a 100644
--- a/README.md
+++ b/README.md
@@ -105,7 +105,24 @@ For Windows users, replace $PWD with the full path to your project directory
 - Github
 - Gitlab
 
-## Configuring Jira
+## Configuration
+
+## GitHub
+
+Ticketing integration with GitHub can be configured with the following YAML in `comply.yml`:
+
+```yaml
+tickets:
+  github:
+    repo: github.com/your-org/SOC2
+    token: <token>
+    username: org-bot-user
+```
+
+Also, `GITHUB_REPO`, `GITHUB_TOKEN`, and `GITHUB_USERNAME` can be used to override values from the YAML file.
+
+### Jira
+
 When comply creates a ticket (through `proc`, for instance), it sets the following fields.
 
 - assignee