From b8404509524001c3f2fb4846cc513a06a38b1dbf Mon Sep 17 00:00:00 2001 From: Cezary Baginski Date: Sat, 27 Jun 2015 12:08:19 +0200 Subject: [PATCH] Release 3.0.0 --- README.md | 13 +++++++++---- lib/listen/version.rb | 2 +- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3f5f7770..e88f4295 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,10 @@ The Listen gem listens to file modifications and notifies you about the changes. ## Known issues / Quickfixes / Workarounds -Just head over here: https://github.com/guard/listen/wiki/Quickfixes,-known-issues-and-workarounds +*NOTE: TCP functionality has been removed from Listen 3.x - please use Listen +2.x until alternative server and client gems are created/released for 3.x.* + +For other issues, just head over here: https://github.com/guard/listen/wiki/Quickfixes,-known-issues-and-workarounds ## Tips and Techniques @@ -23,12 +26,13 @@ Make sure you know these few basic tricks: https://github.com/guard/listen/wiki/ * Increased change detection accuracy on OS X HFS and VFAT volumes. * Tested on MRI Ruby environments (1.9+ only) via [Travis CI](https://travis-ci.org/guard/listen), -Please note that: +NOTE: TCP functionality has been moved to a separate gem (listen-server and listen-client) + +NOTES: - Some filesystems won't work without polling (VM/Vagrant Shared folders, NFS, Samba, sshfs, etc.) - Specs suite on JRuby and Rubinius aren't reliable on Travis CI, but should work. - Windows and \*BSD adapter aren't continuously and automaticaly tested. -NOTE: TCP functionality has been moved to a separate gem (listen-server and listen-client) ## Pending features / issues @@ -43,9 +47,10 @@ Pull request or help is very welcome for these. The simplest way to install Listen is to use [Bundler](http://bundler.io). ```ruby -gem 'listen', '~> 2.7' # this prevents upgrading to 3.x +gem 'listen', '~> 3.0' # NOTE: for TCP functionality, use '~> 2.10' for now ``` + ## Usage Call `Listen.to` with either a single directory or multiple directories, then define the "changes" callback in a block. diff --git a/lib/listen/version.rb b/lib/listen/version.rb index f44e0000..5905984f 100644 --- a/lib/listen/version.rb +++ b/lib/listen/version.rb @@ -1,3 +1,3 @@ module Listen - VERSION = '2.10.1' + VERSION = '3.0.0' end