WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit b840450

Browse files
committed
Release 3.0.0
1 parent 457c3cb commit b840450

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ The Listen gem listens to file modifications and notifies you about the changes.
88

99
## Known issues / Quickfixes / Workarounds
1010

11-
Just head over here: https://github.com/guard/listen/wiki/Quickfixes,-known-issues-and-workarounds
11+
*NOTE: TCP functionality has been removed from Listen 3.x - please use Listen
12+
2.x until alternative server and client gems are created/released for 3.x.*
13+
14+
For other issues, just head over here: https://github.com/guard/listen/wiki/Quickfixes,-known-issues-and-workarounds
1215

1316
## Tips and Techniques
1417

@@ -23,12 +26,13 @@ Make sure you know these few basic tricks: https://github.com/guard/listen/wiki/
2326
* Increased change detection accuracy on OS X HFS and VFAT volumes.
2427
* Tested on MRI Ruby environments (1.9+ only) via [Travis CI](https://travis-ci.org/guard/listen),
2528

26-
Please note that:
29+
NOTE: TCP functionality has been moved to a separate gem (listen-server and listen-client)
30+
31+
NOTES:
2732
- Some filesystems won't work without polling (VM/Vagrant Shared folders, NFS, Samba, sshfs, etc.)
2833
- Specs suite on JRuby and Rubinius aren't reliable on Travis CI, but should work.
2934
- Windows and \*BSD adapter aren't continuously and automaticaly tested.
3035

31-
NOTE: TCP functionality has been moved to a separate gem (listen-server and listen-client)
3236

3337
## Pending features / issues
3438

@@ -43,9 +47,10 @@ Pull request or help is very welcome for these.
4347
The simplest way to install Listen is to use [Bundler](http://bundler.io).
4448

4549
```ruby
46-
gem 'listen', '~> 2.7' # this prevents upgrading to 3.x
50+
gem 'listen', '~> 3.0' # NOTE: for TCP functionality, use '~> 2.10' for now
4751
```
4852

53+
4954
## Usage
5055

5156
Call `Listen.to` with either a single directory or multiple directories, then define the "changes" callback in a block.

lib/listen/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
module Listen
2-
VERSION = '2.10.1'
2+
VERSION = '3.0.0'
33
end

0 commit comments

Comments
 (0)