]> go.fuhry.dev Git - fsnotify.git/commitdiff
readme: test against master
authorNathan Youngman <git@nathany.com>
Wed, 24 Sep 2014 21:47:39 +0000 (15:47 -0600)
committerNathan Youngman <git@nathany.com>
Wed, 24 Sep 2014 21:47:39 +0000 (15:47 -0600)
README.md

index 0759284269cd4832fd9a8a1b9e866c4a8cff1de1..a7945e8a062ac15756568821783a140e1a0f1bc4 100644 (file)
--- a/README.md
+++ b/README.md
@@ -23,22 +23,29 @@ Please see [the documentation](https://godoc.org/gopkg.in/fsnotify.v1) for usage
 
 Two major versions of fsnotify exist. 
 
-**[fsnotify.v1](https://gopkg.in/fsnotify.v1)** provides [a new API](https://godoc.org/gopkg.in/fsnotify.v1) based on [this design document](http://goo.gl/MrYxyA). You can import v1 with:
+**[fsnotify.v0](https://gopkg.in/fsnotify.v0)** is API-compatible with [howeyc/fsnotify](https://godoc.org/github.com/howeyc/fsnotify). Bugfixes *may* be backported, but I recommend upgrading to v1.
 
 ```go
-import "gopkg.in/fsnotify.v1"
+import "gopkg.in/fsnotify.v0"
 ```
 
-\* Refer to the package as fsnotify (without the .v1 suffix).
+\* Refer to the package as fsnotify (without the .v0 suffix).
 
-**[fsnotify.v0](https://gopkg.in/fsnotify.v0)** is API-compatible with [howeyc/fsnotify](https://godoc.org/github.com/howeyc/fsnotify). Bugfixes *may* be backported, but I recommend upgrading to v1.
+**[fsnotify.v1](https://gopkg.in/fsnotify.v1)** provides [a new API](https://godoc.org/gopkg.in/fsnotify.v1) based on [this design document](http://goo.gl/MrYxyA). You can import v1 with:
 
 ```go
-import "gopkg.in/fsnotify.v0"
+import "gopkg.in/fsnotify.v1"
 ```
 
 Further API changes are [planned](https://github.com/go-fsnotify/fsnotify/milestones), but a new major revision will be tagged, so you can depend on the v1 API.
 
+**master** may have untagged changes. Use it to test the very latest code,
+but don't expect it to remain API-compatible:
+
+```go
+import "github.com/go-fsnotify/fsnotify"
+```
+
 ## Contributing
 
 * Send questions to [golang-dev@googlegroups.com](mailto:golang-dev@googlegroups.com).