cmd/relui: add instructions to enable github client in local relui
Change-Id: Ie0aeaad2a2ded04e0a2da5a21b3ba6d8d14a3c30
Reviewed-on: https://go-review.googlesource.com/c/build/+/604115
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
Auto-Submit: Hongxiang Jiang <hxjiang@golang.org>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Robert Findley <rfindley@google.com>
diff --git a/cmd/relui/README.md b/cmd/relui/README.md
index da21edc..e339b0d 100644
--- a/cmd/relui/README.md
+++ b/cmd/relui/README.md
@@ -52,6 +52,18 @@
PGHOST=localhost PGDATABASE=relui-dev PGUSER=postgres go run . -listen-http=localhost:8080 -cloud-build-project PROJECT_ID -scratch-files-base gs://GCS_BUCKET_NAME
```
+### Enable GitHub Client in your local relui
+
+Use github [token](https://github.com/settings/tokens/new) page to generate a
+new access token.
+
+Run relui with additional parameters `-github-token`. The local relui will use
+your personal credential to talk to github.
+
+```bash
+PGHOST=localhost PGDATABASE=relui-dev PGUSER=postgres go run . -listen-http=localhost:8080 -github-token TOKEN
+```
+
### Updating Queries
Create or edit SQL files in `internal/relui/queries`.
