Add config generator

README.md

@@ -34,6 +34,23 @@ The basic workflow looks like this:
 1. **List** -- get a list of your configured projects any time with `plist`
 1. **Reward** -- buy the author a beer, because this thing is a time saver
 
+## Installing
+
+1. Install into your go path by running `go install .`
+1. Copy `contrib/gpm_func_omz.zsh` into your `~/.oh-my-zsh/custom/` path, or just source from your bashrc/zshrc
+1. Generate config file: `gpm config gen --write`
+    1. You can run this any time to update settings
+1. Run `gpm cache load` (if aliases is in-place, otherwise `gitlab-project-manager cache load`)
+
+### Config Sample
+```yaml
+gitlabHost: https://gitlab.sweetwater.com
+gitlabToken: <your token here>
+logLevel: info
+cache:
+  ttl: 168h
+    ownerOnly: false
+```
 ## TODO
 
 - [ ] Fix NPE when cache is reset or project for whatever reason leaves an orphaned alias
@@ -49,6 +66,8 @@ The basic workflow looks like this:
 - [ ] Make a Makefile
 - [ ] Add git repo status to project go (up-to-date, pending commits, etc..)
 - [ ] Update `gpm project show` with pterm box like `gpm project list`
+- [ ] Build pipeline, and link to gitlab registry for a release binary
+- [ ] Brew package and GitHub
 - [x] Merge aliases together for same project when selecting
 	- [x] If after merging there is only one project, go there by default