From 03206ef31ebe44a6db9e66f3b466e05a31790631 Mon Sep 17 00:00:00 2001 From: Gary Burd Date: Thu, 20 Mar 2014 13:26:28 -0700 Subject: [PATCH] Various improvements to README files. --- README.md | 3 ++- examples/filewatch/README.md | 11 +++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 627e206..634eb38 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,9 @@ Gorilla WebSocket is a [Go](http://golang.org/) implementation of the ### Documentation -* [Reference](http://godoc.org/github.com/gorilla/websocket) +* [API Reference](http://godoc.org/github.com/gorilla/websocket) * [Chat example](https://github.com/gorilla/websocket/tree/master/examples/chat) +* [File watch example](https://github.com/gorilla/websocket/tree/master/examples/filewatch) ### Status diff --git a/examples/filewatch/README.md b/examples/filewatch/README.md index a84fcb8..ca4931f 100644 --- a/examples/filewatch/README.md +++ b/examples/filewatch/README.md @@ -1,10 +1,9 @@ # File Watch example. -This example displays the contents of a file in the browser. If the file -changes, the server sends the update file to the browser. +This example sends a file to the browser client for display whenever the file is modified. $ go get github.com/gorilla/websocket - $ cd `go list -f '{{.Dir}}' github.com/gorilla/websocket/examples/tail` - $ go run tail.go - # open http://localhost:8080/ - # modify the file to see it update in the browser. + $ cd `go list -f '{{.Dir}}' github.com/gorilla/websocket/examples/filewatch` + $ go run main.go + # Open http://localhost:8080/ . + # Modify the file to see it update in the browser.