From d338a0b9a7274fc4dac0d451df2cbf38ee77fca6 Mon Sep 17 00:00:00 2001 From: Jay Gabriels Date: Sat, 21 Apr 2018 20:24:08 -0700 Subject: [PATCH] update readme --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index f51fa51..a13b095 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,21 @@ # ghorg -### Purpose +## Purpose + Github search is terrible. The idea here is quickly clone all org repos into a single directory and use something like ack for searching the org. Can also be used for setting up kuve -### Use -`$ ghorg nameoforg` +## Use -### Setup -1. $ git clone -1. $ cd ghorg -1. $cp .env-sample .env -2. update your .env -2. $ make install -3. $ go install +- $ ghorg nameoforg -### Auth +## Setup + +- $ git clone +- $ cd ghorg +- $ cp .env-sample .env +- update your .env +- $ make install +- $ go install + +## Auth - If org is behind SSO add it to the [Github token](https://help.github.com/articles/authorizing-a-personal-access-token-for-use-with-a-saml-single-sign-on-organization/)