Merge pull request #15 from hellofresh/feature/improve-docs

Improve docs

Author: PepijnSenders

.github.sample.toml

@@ -1,15 +1,7 @@
-# Where your public ssh key that is registered on Github is. By default it 
+# Where your public ssh key that is registered on Github is. By default it
 # looks in your ssh folder for a file called `id_rsa`
 # PublicKeyPath = ~/.ssh/id_rsa
 
-[pullapprove]
-    # Defines the pull approve organization
-    Token=""
-    # Defines the pull approve filename
-    filename="./.pullapprove.yml"
-    # Defines the pull approve branch
-    protectedBranchName="master"
-
 # Zappr Config
 [zappr]
     # Defines the url for Zappr. Comment it out to load it from ZAPPR_URL environment variable
@@ -20,16 +12,19 @@
 
 [github]
     # Defines the github organization
-    Organization="yourOrg"
+    Organization="hellofresh"
 
     # Defines the github token
+    # Create a new one here: https://github.com/settings/tokens/new with `repo` access
     Token=""
 
     # Defines permission specifies the permission to grant the team on this repository.
-	# Possible values are:
-	#     pull - team members can pull, but not push to or administer this repository
-	#     push - team members can pull and push, but not administer this repository
-	#     admin - team members can pull, push and administer this repository
+  	# Possible values are:
+  	#     pull - team members can pull, but not push to or administer this repository
+  	#     push - team members can pull and push, but not administer this repository
+  	#     admin - team members can pull, push and administer this repository
+
+    # To get a team ID: curl -s -i -X GET -u TOKEN:x-oauth-basic -d '' https://api.github.com/orgs/hellofresh/teams | grep -A1 "TEAM_NAME"
     Teams=[
         #Example
         {ID=1234, Permission='pull'},
@@ -43,7 +38,8 @@
 
     # Adds a set of labels when creating the repo
     Labels=[
-        {Name='custom', Color='ad974f'}, 
+        {Name="Please CR", Color="c2e0c6"},
+        {Name="Do not merge", Color="b60205"},
     ]
 
     # Removes the default github's labels
@@ -55,7 +51,7 @@
     ]
 
     # Defines branch protections
-    Protections={master=["code-review/pullapprove"]}
+    Protections={master=["zappr"]}
 
 [githubtestorg]
     # Defines the github test organization

README.md

@@ -5,43 +5,71 @@
 
 > A CLI Tool to automate the creation of github repositories
 
-This is a simple, CLI tool that helps you to create github repositories. 
+This is a simple, CLI tool that helps you to create github repositories.
 It adds all required integrations, teams, webhooks, etc.. all based on a configuration file that you define.
 
 ## Installation
 
 You can get the binary and play with it in your own environment (or even deploy it wherever you like it).
 Just go the [releases](https://github.com/hellofresh/github-cli/releases) and download the latest one for your platform.
 
-Just place the binary in your $PATH and you are good to go.
+Move the downloaded binary to any place that's in your `$PATH`, usually you would add it to the local bin:
+
+```
+$ mv ~/Downloads/github-cli /usr/local/bin/github-cli
+$ chmod +x /usr/local/bin/github-cli
+```
 
 ## Getting Started
 
-After you have *github-cli* up and running we can create our first repository.
-First of all we have to create a configuration file that will customize how our repositories will be created. You can have a look on our [example](.github.sample.toml).
-This file can be placed on the same folder as your binary is, or in your home directory and it should be named `.github.toml` (You can also use it as `yaml` or `json`).
+After you have _github-cli_ up and running we can create our first repository.
+First of all we have to create a configuration file that will customise how our repositories will be created. You can have a look at our [example](./.github.sample.toml) and copy it.
+
+You will need to fill in the following values to be able to create a repo:
+
+### Zappr `zappr`
+
+For Zappr you will need a Zappr URL and a Zappr token, the URL is the base URL of your zappr configuration and the token can be found when you login into the UI and copy the value of any request going out the same domain. The cookies that you need are http-only so you can't access them through JS. Just look for a request with the `Cookie:` header and then copy the value.
+
+### GitHub `github`
+
+GitHub needs a [token](https://github.com/settings/tokens/new) with repo access. You can add additional collaborators and/or teams, the teams are defined by ID and the ID can be found with this simple cURL:
+
+```
+$ curl -s -i -X GET -u TOKEN:x-oauth-basic -d '' https://api.github.com/orgs/hellofresh/teams | grep -A1 "TEAM_NAME"
+```
+
+Check out descriptions on the other config values in the [sample file](./.github.sample.toml).
+
+### GitHub Test Org `githubtestorg`
+
+This is used for creating GitHub tests. This just needs a GitHub token with repo access.
+
+### Finalising the file
+
+You can either write this file to be next to the binary or add it to `~/.github.toml`, we recommend the latter!
 
 ## Usage
 
 ```
 github-cli [command] [--flags]
-``` 
+```
 
 ### Commands
 
-| Command                  | Description                          |
-|--------------------------|--------------------------------------|
-| `github-cli repo create [--flags]`   | Creates a new github repository      |
-| `github-cli repo delete [--flags]`   | Deletes a github repository          |
-| `github-cli hiring send [--flags]`   | Creates a new hellofresh hiring test |
+| Command                              | Description                                      |
+| ------------------------------------ | ------------------------------------------------ |
+| `github-cli repo create [--flags]`   | Creates a new github repository                  |
+| `github-cli repo delete [--flags]`   | Deletes a github repository                      |
+| `github-cli hiring send [--flags]`   | Creates a new hellofresh hiring test             |
 | `github-cli hiring unseat [--flags]` | Removes external collaborators from repositories |
-| `github-cli update `                 | Check for new versions of github-cli |
-| `github-cli version`                 | Prints the version information |
+| `github-cli update`                  | Check for new versions of github-cli             |
+| `github-cli version`                 | Prints the version information                   |
 
 ## Contributing
 
 To start contributing, please check [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Documentation
 
-* Phanes Docs: https://godoc.org/github.com/hellofresh/github-cli
+- Phanes Docs: https://godoc.org/github.com/hellofresh/github-cli