Minor config example cleanup

Author: glinton

.travis.yml

@@ -1,7 +1,7 @@
 language: go
 
 go:
-  - 1.5
+  - 1.6
 
 go_import_path: github.com/nanopack/hoarder
 install: go get -t -v .

README.md

@@ -36,7 +36,7 @@ Available Commands:
 Flags:
   -b, --backend string       Hoarder backend (default "file:///var/db/hoarder")
   -g, --clean-after uint     Age, in seconds, after which data is deemed garbage (default 0)
-      --config string        /path/to/config.yml
+  -c, --config string        Path to config file (with extension)
   -H, --listen-addr string   Hoarder listen uri (scheme defaults to https) (default "https://127.0.0.1:7410")
       --log-level string     Output level of logs (TRACE, DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO")
   -s, --server               Run hoarder as a server
@@ -52,7 +52,6 @@ To configure hoarder, a config.yml file can be passed with --config. Configurati
 
 ```yml
 backend     : "file:///var/db/hoarder"    # the pluggable backend the api will use for storage
-clean-after : 0                           # the age that data is deemed garbage (seconds)
 listen-addr : "https://127.0.0.1:7410"    # the connection host uri (scheme defaults to https)
 log-level   : "INFO"                      # the output log level (trace, debug, info, warn, error, fatal)
 server      : false                       # run as a server
@@ -69,8 +68,8 @@ token       : ""                          # the secure token used to connect wit
 | POST   | /blobs/{:id} | Publish a new blob
 | PUT    | /blobs/{:id} | Update an existing blob
 | DELETE | /blobs/{:id} | Remove an existing blob
-| GET    | /blobs"      | List all blobs
-| HEAD   | /blobs"      | Retrieve file information for all blobs
+| GET    | /blobs       | List all blobs
+| HEAD   | /blobs       | Retrieve file information for all blobs
 ```
 
 #### Examples

api/api.go

@@ -15,24 +15,23 @@ import (
 
 // Start starts the api listener
 func Start() error {
-
-	u, err := url.Parse(viper.GetString("listen-addr"))
+	uri, err := url.Parse(viper.GetString("listen-addr"))
 	if err != nil {
-		return fmt.Errorf("Failed to parse db connection - %v", err)
+		return fmt.Errorf("Failed to parse 'listen-addr' - %v", err)
 	}
 
 	// blocking...
 	nanoauth.DefaultAuth.Header = "X-AUTH-TOKEN"
 
 	// listen http (with auth support)
-	if u.Scheme == "http" {
-		lumber.Info("Starting hoarder server at 'http://%s'...", u.Host)
-		return nanoauth.ListenAndServe(u.Host, viper.GetString("token"), routes(), "/ping")
+	if uri.Scheme == "http" {
+		lumber.Info("Starting hoarder server at 'http://%s'...", uri.Host)
+		return nanoauth.ListenAndServe(uri.Host, viper.GetString("token"), routes(), "/ping")
 	}
 
 	// listen https
-	lumber.Info("Starting secure hoarder server at 'https://%s'...", u.Host)
-	return nanoauth.ListenAndServeTLS(u.Host, viper.GetString("token"), routes(), "/ping")
+	lumber.Info("Starting secure hoarder server at 'https://%s'...", uri.Host)
+	return nanoauth.ListenAndServeTLS(uri.Host, viper.GetString("token"), routes(), "/ping")
 }
 
 // routes registers all api routes with the router

commands/README.md

@@ -25,7 +25,7 @@ Available Commands:
 Flags:
   -b, --backend string       Hoarder backend (default "file:///var/db/hoarder")
   -g, --clean-after uint     Age, in seconds, after which data is deemed garbage (default 0)
-      --config string        /path/to/config.yml
+  -c, --config string        Path to config file (with extension)
   -H, --listen-addr string   Hoarder listen uri (scheme defaults to https) (default "https://127.0.0.1:7410")
       --log-level string     Output level of logs (TRACE, DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO")
   -s, --server               Run hoarder as a server

commands/commands.go

@@ -147,7 +147,7 @@ func init() {
 	viper.BindPFlag("server", HoarderCmd.Flags().Lookup("server"))
 
 	// cli-only flags
-	HoarderCmd.Flags().StringVar(&config, "config", "", "/path/to/config.yml")
+	HoarderCmd.Flags().StringVarP(&config, "config", "c", "", "Path to config file (with extension)")
 	HoarderCmd.Flags().BoolVarP(&showVers, "version", "v", false, "Display the current version of this CLI")
 
 	// commands

main.go

@@ -20,7 +20,7 @@
 //  Flags:
 //    -b, --backend string       Hoarder backend (default "file:///var/db/hoarder")
 //    -g, --clean-after uint     Age, in seconds, after which data is deemed garbage (default 0)
-//        --config string        /path/to/config.yml
+//    -c, --config string        Path to config file
 //    -H, --listen-addr string   Hoarder listen uri (scheme defaults to https) (default "https://127.0.0.1:7410")
 //        --log-level string     Output level of logs (TRACE, DEBUG, INFO, WARN, ERROR, FATAL) (default "INFO")
 //    -s, --server               Run hoarder as a server