소스 검색

Various improvements to README files.

Gary Burd 11 년 전
부모
커밋
03206ef31e
2개의 변경된 파일7개의 추가작업 그리고 7개의 파일을 삭제
  1. 2 1
      README.md
  2. 5 6
      examples/filewatch/README.md

+ 2 - 1
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
 

+ 5 - 6
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 <name of file>
-    # 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 <name of file to watch>
+    # Open http://localhost:8080/ .
+    # Modify the file to see it update in the browser.