add file backend to quick start guide (kelseyhightower#727)

* add file backend to quick start guide * add formatting to file backend debug call * fix my poorly exec'ed fork update
msolimans · Jul 16, 2018 · cccd334 · cccd334
1 parent 3d9acde
commit cccd334
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/backends/file/client.go b/backends/file/client.go
@@ -112,7 +112,7 @@ func (c *Client) watchChanges(watcher *fsnotify.Watcher, stopChan chan bool) Res
 		for {
 			select {
 			case event := <-watcher.Events:
-				log.Debug("event: %v", event)
+				log.Debug(fmt.Sprintf("Event: %s", event))
 				if event.Op&fsnotify.Write == fsnotify.Write ||
 					event.Op&fsnotify.Remove == fsnotify.Remove ||
 					event.Op&fsnotify.Create == fsnotify.Create {

diff --git a/docs/quick-start-guide.md b/docs/quick-start-guide.md
@@ -10,6 +10,7 @@ confd supports the following backends:
 * consul
 * vault
 * environment variables
+* file
 * redis
 * zookeeper
 * dynamodb
@@ -47,6 +48,16 @@ export MYAPP_DATABASE_URL=db.example.com
 export MYAPP_DATABASE_USER=rob
 ```
 
+#### file
+
+myapp.yaml
+```
+myapp:
+  database:
+    url: db.example.com
+    user: rob
+```
+
 #### redis
 
 ```
@@ -165,6 +176,12 @@ confd -onetime -backend dynamodb -table <YOUR_TABLE>
 confd -onetime -backend env
 ```
 
+#### file
+
+```
+confd -onetime -backend file -file myapp.yaml
+```
+
 #### redis
 
 ```