added docs for the example config file

.gitignore

@@ -12,12 +12,10 @@
 
 # Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736
 .glide/
-main.db
-debug
-*db.lock
 
 /config.*
 /handlers/static.go
 /handlers/tmpls/tmpls.go
+/store/main.db
 /releases
 /data

build/config.yaml

@@ -1,11 +1,11 @@
 http:
-  ListenAddr: ':8080'
+  ListenAddr: ':8080'              # Consists of 'IP:Port', e.g. ':8080' listens on any IP and on Port 8080
-  BaseURL: 'http://localhost:3000'
+  BaseURL: 'http://localhost:3000' # Origin URL, required for the authentication via OAuth
 General:
-  DBPath: main.db
+  DataDir: ./data                  # Contains: the database and the private key
-  EnableDebugMode: true
+  EnableDebugMode: true            # Activates more detailed logging
-  ShortedIDLength: 4
+  ShortedIDLength: 4               # Length of the random generated ID which is used for new shortened URLs
 oAuth:
   Google:
-    ClientID: replace me
+    ClientID: replace me           # ClientID which you get from console.cloud.google.com
-    ClientSecret: replace me
+    ClientSecret: replace me       # ClientSecret which get from console.cloud.google.com