Update README change description config key

Author: michaeljs1990

README.md

@@ -7,65 +7,59 @@ as well as push to any git, http, https, or ssh repository. Additinally I have a
 some features for populating metadata on cgit repositories that you can turn on if you
 want.
 
-Currently windows is not supported due to the use of syscalls that aren't supported. If
-a windows user comes along who would like to use open a ticket and we can work something
-out.
-
-## Features
-
-|Feature                               |Done|Kinda|Planned|Wishful|
-|--------------------------------------|:--:|:---:|:-----:|:-----:|
-|Clone repositories from github        |X   |     |       |       |
-|Clone repositories from bitbucket     |    |     |       |X      |
-|Clone repositories from gitlab        |    |     |       |X      |
-|Push repo over http auth              |X   |     |       |       |
-|Pull repo over http auth              |X   |     |       |       |
-|Push repo over git protocol           |X   |     |       |       |
-|Pull repo over git protocol           |X   |     |       |       |
-|Push repo over SSH protocol           |X   |     |       |       |
-|SSH user/pass auth                    |X   |     |       |       |
-|SSH private key auth                  |X   |     |       |       |
-|Pull repo over SSH protocol           |X   |     |       |       |
-|Config validation                     |X   |     |       |       |
-|Prometheus metrics                    |X   |     |       |       |
-|Hot config reloading                  |X   |     |       |       |
-|Force syncing without process restart |X   |     |       |       |
-|Add unit tests                        |    |     |       |X      |
-|Add file watching for push repos      |    |     |       |X      |
-|Populate some cgit metadata           |X   |     |       |       |
+This works on all OS but hot reloading of config on windows doesn't work.
 
 ## Config
 
-Here is an example config file. To validate your config you can run `git-sync -validate -config file.yaml`.
+Here is an example config file with secrets replaced. To validate your config you can 
+run `git-sync -validate -config file.yaml`.
 
 ```
 ---
 interval: 3600
 path: /var/lib/repos
 repos:
-- url: https://github.com/michaeljs1990/git-sync.git
+- url: https://review.coreboot.org/coreboot.git
+  type: fetch_mirror
+  path: /var/lib/repos/mirrors/coreboot
+  extras:
+    cgitowner: coreboot
+    cgitsection: mirrors
+  metadata:
+  - cgit
+- url: https://anongit.gentoo.org/git/repo/gentoo.git
+  type: fetch_mirror
+  path: /var/lib/repos/mirrors/gentoo
+  extras:
+    cgitowner: gentoo
+    cgitsection: mirrors
+  metadata:
+  - cgit
+- url: https://github.com/michaeljs1990/collins-go-cli.git
   type: push_mirror
-  path: /var/lib/repos/git-sync
+  path: /var/lib/repos/xrt0x/collins-go-cli
   httpauth:
-    user: username
-    token: sometoken
+    user: michaeljs1990
+    token: some-token
   remote: github_mirror
-- url: ssh://[email protected]:repos/git-sync
-  type: fetch_mirror
-  path: /tmp/test_repo/test
-  sshkeyauth:
-    user: git
-    keypath: ~/.ssh/id_rsa
-  remote: mirror
 github:
 - username: michaeljs1990
   httpauth:
-    user: username
-    token: sometoken
-  protocol: http
+    user: michaeljs1990
+    token: some-token
   repos: true
+  metadata:
+  - cgit
 ```
 
+## Sync Types
+
+`push_mirror` - Push from the local path provided to the given URL to keep them in sync.
+
+`fetch_mirror` - Pull from the url provided and place it at the provided path.
+
+`github` - pull all repos located under the provided username to the top level path.
+
 ## Example
 
 Run one time to test out your config
@@ -93,7 +87,6 @@ Validate your config
 ```
 git-sync -validate
 ```
-
 ## Signals
 
 You can reload the config file for your git-sync process with the use of usr1. This will validate
@@ -105,5 +98,27 @@ This will cause it to sync all repositories again that it knows about.
 
 ## Development
 
-Only tested with go 1.11
+Test with golang 1.11 - 1.13
 
+## Feature List
+
+|Feature                               |Done|Kinda|Planned|Wishful|
+|--------------------------------------|:--:|:---:|:-----:|:-----:|
+|Clone repositories from bitbucket     |    |     |       |X      |
+|Clone repositories from gitlab        |    |     |       |X      |
+|Add unit tests                        |    |     |       |X      |
+|Add file watching for push repos      |    |     |       |X      |
+|Clone repositories from github        |X   |     |       |       |
+|Push repo over http auth              |X   |     |       |       |
+|Pull repo over http auth              |X   |     |       |       |
+|Push repo over git protocol           |X   |     |       |       |
+|Pull repo over git protocol           |X   |     |       |       |
+|Push repo over SSH protocol           |X   |     |       |       |
+|SSH user/pass auth                    |X   |     |       |       |
+|SSH private key auth                  |X   |     |       |       |
+|Pull repo over SSH protocol           |X   |     |       |       |
+|Config validation                     |X   |     |       |       |
+|Prometheus metrics                    |X   |     |       |       |
+|Hot config reloading                  |X   |     |       |       |
+|Force syncing without process restart |X   |     |       |       |
+|Populate some cgit metadata           |X   |     |       |       |

main.go

@@ -76,7 +76,7 @@ type Extras struct {
 	Username    string `json:"username"`
 	CgitSection string `json:"cgitsection"`
 	CgitOwner   string `json:"cgitowner"`
-	Description string `json:"description"`
+	Description string `json:"cgitdescription"`
 }
 
 // RepoConfig is for adhoc servers that may not live

schema.go

@@ -68,10 +68,10 @@ var schema = `
                 "type": "string",
                 "title": "The Cgitowner Schema"
               },
-              "description": {
+              "cgitdescription": {
                 "$id": "#/properties/github/items/properties/extras/properties/description",
                 "type": "string",
-                "title": "The Description Schema"
+                "title": "The Cgitdescription Schema"
               }
             }
           },