listen 0.7.3 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ddde18cc71f8d339471f213dba615ae73e37065
+  data.tar.gz: c8c634ac2be8bcf0187eb647052b6386e5136931
+SHA512:
+  metadata.gz: 4a84e00be4585046590e28f2a8020336c8cb6ad1da212b93354ebee37efea5dc6077586cc3d242a69526e5dbd05eb486240b6645a7120f6fd343c560af08bef3
+  data.tar.gz: 57b2e4b3d73c702d4458a4f6bb62ae36a70bbb69c334fabc01181bcc7173c192a706974691126f175f107c947f1d538cbf85ea3278e6417a729f100f04687094

data/CHANGELOG.md

@@ -1,56 +1,78 @@
-## 0.7.3 - February 24, 2013
+## 1.0.0 - April 20, 2013
 
 ### Bug fix
 
-- [#88] Update wdm dependency. (fixed by [@mrbinky3000][])
-- [#78] Depend on latest rb-inotify. (fixed by [@mbj][])
+- [#93][] Remove dependency operator in the "gem install" message. (reported by [@scottdavis][], fixed by [@rymai][])
+
+### Changes & deprecations
+
+- [#98][] `Listen.to` does not block the current thread anymore. Use `Listen.to!` if you want the old behavior back. ([@rymai][])
+- [#98][] `Listen::Listener#start` does not block the current thread anymore. Use `Listen::Listener#start!` if you want the old behavior back. ([@rymai][])
+- [#98][] `Listen::Listener#start`'s `blocking` parameter is deprecated. ([@rymai][])
+
+### Improvements
+
+- [#98][] New method: `Listen.to!` which blocks the current thread. ([@rymai][])
+- [#98][] New method: `Listen::Listener#start!` to start the listener and block the current thread. ([@martikaljuve][] & [@rymai][])
+- [#95][] Make `Listen::Listener` capable of listening to multiple directories, deprecates `Listen::MultiListener`. ([@rymai][])
+- [#85][] Compute the SHA1 sum only for regular files. ([@antifuchs][])
+- New methods: `Listen::Adapter#pause`, `Listen::Adapter#unpause` and `Listen::Adapter#paused?`. ([@rymai][])
+- Refactor `Listen::DirectoryRecord` internals. ([@rymai][])
+- Refactor `Listen::DependencyManager` internals. ([@rymai][])
+
+## 0.7.3 - February 24, 2013
+
+### Bug fixes
+
+- [#88][] Update wdm dependency. ([@mrbinky3000][])
+- [#78][] Depend on latest rb-inotify. ([@mbj][])
 
 ## 0.7.2 - January 11, 2013
 
 ### Bug fix
 
-- [#76] Exception on filename which is not in UTF-8. (fixed by [@piotr-sokolowski][])
+- [#76][] Exception on filename which is not in UTF-8. ([@piotr-sokolowski][])
 
 ## 0.7.1 - January 6, 2013
 
 ### Bug fix
 
-- [#75] Default high precision off if the mtime call fails. (fixed by [@zanker][])
+- [#75][] Default high precision off if the mtime call fails. ([@zanker][])
 
 ## 0.7.0 - December 29, 2012
 
-### Bug fixes
+### Bug fix
 
-- [#73] Rescue Errno::EOPNOTSUPP on sha1_checksum generation. (fixed by [@thibaudgg][])
+- [#73][] Rescue Errno::EOPNOTSUPP on sha1_checksum generation. ([@thibaudgg][])
 
 ### New feature
 
-- Add support for *BSD with rb-kqueue. ([@mat813][])
+- [#72][] Add support for *BSD with rb-kqueue. ([@mat813][])
 
 ## 0.6.0 - November 21, 2012
 
 ### New feature
 
-- Add bang versions for filter and ignore listener methods. ([@tarsolya][])
+- [#68][] Add bang versions for `Listener#filter` and `Listener#ignore` methods. ([@tarsolya][])
 
 ## 0.5.3 - October 3, 2012
 
 ### Bug fixes
 
-- [#65] Fix ruby warning in adapter.rb. (fixed by [@vongruenigen][])
-- [#64] ENXIO raised when hashing UNIX domain socket file. (fixed by [@sunaku][])
+- [#65][] Fix ruby warning in adapter.rb. ([@vongruenigen][])
+- [#64][] ENXIO raised when hashing UNIX domain socket file. ([@sunaku][])
 
 ## 0.5.2 - Septemper 23, 2012
 
 ### Bug fix
 
-- [#62] Fix double change callback with polling adapter. (fixed by [@thibaudgg][])
+- [#62][] Fix double change callback with polling adapter. ([@thibaudgg][])
 
 ## 0.5.1 - Septemper 18, 2012
 
 ### Bug fix
 
-- [#61] Fix a synchronisation bug that caused constant fallback to polling. (fixed by [@Maher4Ever][])
+- [#61][] Fix a synchronisation bug that caused constant fallback to polling. ([@Maher4Ever][])
 
 ## 0.5.0 - Septemper 1, 2012
 
@@ -62,60 +84,60 @@
 
 ### Improvements
 
-- [#28] Enhance the speed of detecting changes on Windows by using the [WDM][] library. ([@Maher4Ever][])
+- [#28][] Enhance the speed of detecting changes on Windows by using the [WDM][] library. ([@Maher4Ever][])
 
 ## 0.4.7 - June 27, 2012
 
 ### Bug fixes
 
-- Increase latency to 0.25, to avoid useless polling fallback. (fixed by [@thibaudgg][])
-- Change watched inotify events, to avoid duplication callback. (fixed by [@thibaudgg][])
-- [#41](https://github.com/guard/listen/issues/41) Use lstat instead of stat when calculating mtime. (fixed by [@ebroder][])
+- Increase latency to 0.25, to avoid useless polling fallback. ([@thibaudgg][])
+- Change watched inotify events, to avoid duplication callback. ([@thibaudgg][])
+- [#41][] Use lstat instead of stat when calculating mtime. ([@ebroder][])
 
 ## 0.4.6 - June 20, 2012
 
 ### Bug fix
 
-- [#39](https://github.com/guard/listen/issues/39) Fix digest race condition. (fixed by [@dkubb][])
+- [#39][] Fix digest race condition. ([@dkubb][])
 
 ## 0.4.5 - June 13, 2012
 
 ### Bug fix
 
-- [#39](https://github.com/guard/listen/issues/39) Rescue Errno::ENOENT when path inserted doesn't exist. (reported by [@textgoeshere][], fixed by [@thibaudgg][] and [@rymai][])
+- [#39][] Rescue Errno::ENOENT when path inserted doesn't exist. (reported by [@textgoeshere][], fixed by [@thibaudgg][] and [@rymai][])
 
 ## 0.4.4 - June 8, 2012
 
 ### Bug fixes
 
-- ~~[#39](https://github.com/guard/listen/issues/39) Non-existing path insertion bug. (reported by [@textgoeshere][], fixed by [@thibaudgg][])~~
+- ~~[#39][] Non-existing path insertion bug. (reported by [@textgoeshere][], fixed by [@thibaudgg][])~~
 - Fix relative path for directories containing special characters. (reported by [@napcs][], fixed by [@netzpirat][])
 
 ## 0.4.3 - June 6, 2012
 
 ### Bug fixes
 
-- [#24](https://github.com/guard/listen/issues/24) Fail gracefully when the inotify limit is not enough for Listen to function. (reported by [@daemonza][], fixed by [@Maher4Ever][])
-- [#32](https://github.com/guard/listen/issues/32) Fix a crash when trying to calculate the checksum of unreadable files. (reported by [@nex3][], fixed by [@Maher4Ever][])
+- [#24][] Fail gracefully when the inotify limit is not enough for Listen to function. (reported by [@daemonza][], fixed by [@Maher4Ever][])
+- [#32][] Fix a crash when trying to calculate the checksum of unreadable files. (reported by [@nex3][], fixed by [@Maher4Ever][])
 
 ### Improvements
 
-- Add `#relative_paths` method to listeners. ([@Maher4Ever][])
-- Add `#started?` query-method to adapters. ([@Maher4Ever][])
+- Add `Listener#relative_paths`. ([@Maher4Ever][])
+- Add `Adapter#started?`. ([@Maher4Ever][])
 - Dynamically detect the mtime precision used on a system. ([@Maher4Ever][] with help from [@nex3][])
 
 ## 0.4.2 - May 1, 2012
 
 ### Bug fixes
 
-- [#21](https://github.com/guard/listen/issues/21) Issues when listening to changes in relative paths. (reported by [@akerbos][], fixed by [@Maher4Ever][])
-- [#27](https://github.com/guard/listen/issues/27) Wrong reports for files modifications. (reported by [@cobychapple][], fixed by [@Maher4Ever][])
+- [#21][] Issues when listening to changes in relative paths. (reported by [@akerbos][], fixed by [@Maher4Ever][])
+- [#27][] Wrong reports for files modifications. (reported by [@cobychapple][], fixed by [@Maher4Ever][])
 - Fix segmentation fault when profiling on Windows. ([@Maher4Ever][])
 - Fix redundant watchers on Windows. ([@Maher4Ever][])
 
 ### Improvements
 
-- [#17](https://github.com/guard/listen/issues/17) Use regexp-patterns with the `ignore` method instead of supplying paths. (reported by [@fny][], added by [@Maher4Ever][])
+- [#17][] Use regexp-patterns with the `ignore` method instead of supplying paths. (reported by [@fny][], added by [@Maher4Ever][])
 - Speed improvement when listening to changes in directories with ignored paths. ([@Maher4Ever][])
 - Added `.rbx` and `.svn` to ignored directories. ([@Maher4Ever][])
 
@@ -123,13 +145,13 @@
 
 ### Bug fix
 
-- [#18](https://github.com/guard/listen/issues/18) Listener crashes when removing directories with nested paths. (reported by [@daemonza][], fixed by [@Maher4Ever][])
+- [#18][] Listener crashes when removing directories with nested paths. (reported by [@daemonza][], fixed by [@Maher4Ever][])
 
 ## 0.4.0 - April 9, 2012
 
 ### New features
 
-- Add `wait_for_callback` method to all adapters. ([@Maher4Ever][])
+- Add `Adapter#wait_for_callback`. ([@Maher4Ever][])
 - Add `Listen::MultiListener` class to listen to multiple directories at once. ([@Maher4Ever][])
 - Allow passing multiple directories to the `Listen.to` method. ([@Maher4Ever][])
 - Add `blocking` option to `Listen#start` which can be used to disable blocking the current thread upon starting. ([@Maher4Ever][])
@@ -163,7 +185,7 @@
 
 ### Bug fix
 
-- [#9](https://github.com/guard/listen/issues/9) Ignore doesn't seem to work. (reported by [@markiz][], fixed by [@thibaudgg][])
+- [#9][] Ignore doesn't seem to work. (reported by [@markiz][], fixed by [@thibaudgg][])
 
 ## 0.3.0 - February 21, 2012
 
@@ -181,7 +203,7 @@
 - Add rb-inotify support. ([@thibaudgg][] with [@Maher4Ever][] help)
 - Add rb-fsevent support. ([@thibaudgg][])
 - Add non-recursive diff with multiple directories support. ([@thibaudgg][])
-- Ignore .DS_Store by default. ([@thibaudgg][])
+- Ignore `.DS_Store` files by default. ([@thibaudgg][])
 
 ## 0.1.0 - January 28, 2012
 
@@ -196,23 +218,37 @@
 [#27]: https://github.com/guard/listen/issues/27
 [#28]: https://github.com/guard/listen/issues/28
 [#32]: https://github.com/guard/listen/issues/32
+[#39]: https://github.com/guard/listen/issues/39
 [#41]: https://github.com/guard/listen/issues/41
 [#61]: https://github.com/guard/listen/issues/61
 [#62]: https://github.com/guard/listen/issues/62
 [#64]: https://github.com/guard/listen/issues/64
 [#65]: https://github.com/guard/listen/issues/65
+[#68]: https://github.com/guard/listen/issues/68
+[#72]: https://github.com/guard/listen/issues/72
 [#73]: https://github.com/guard/listen/issues/73
 [#75]: https://github.com/guard/listen/issues/75
 [#76]: https://github.com/guard/listen/issues/76
+[#78]: https://github.com/guard/listen/issues/78
+[#85]: https://github.com/guard/listen/issues/85
+[#88]: https://github.com/guard/listen/issues/88
+[#93]: https://github.com/guard/listen/issues/93
+[#95]: https://github.com/guard/listen/issues/95
+[#96]: https://github.com/guard/listen/issues/96
+[#98]: https://github.com/guard/listen/issues/98
 [@Maher4Ever]: https://github.com/Maher4Ever
-[@dkubb]: https://github.com/dkubb
-[@ebroder]: https://github.com/ebroder
 [@akerbos]: https://github.com/akerbos
+[@antifuchs]: https://github.com/antifuchs
 [@cobychapple]: https://github.com/cobychapple
 [@daemonza]: https://github.com/daemonza
+[@dkubb]: https://github.com/dkubb
+[@ebroder]: https://github.com/ebroder
 [@fny]: https://github.com/fny
 [@markiz]: https://github.com/markiz
+[@martikaljuve]: https://github.com/martikaljuve
 [@mat813]: https://github.com/mat813
+[@mbj]: https://github.com/mbj
+[@mrbinky3000]: https://github.com/mrbinky3000
 [@napcs]: https://github.com/napcs
 [@netzpirat]: https://github.com/netzpirat
 [@nex3]: https://github.com/nex3
@@ -220,9 +256,8 @@
 [@rymai]: https://github.com/rymai
 [@scottdavis]: https://github.com/scottdavis
 [@sunaku]: https://github.com/sunaku
+[@tarsolya]: https://github.com/tarsolya
 [@textgoeshere]: https://github.com/textgoeshere
 [@thibaudgg]: https://github.com/thibaudgg
-[@tarsolya]: https://github.com/tarsolya
 [@vongruenigen]: https://github.com/vongruenigen
 [@zanker]: https://github.com/zanker
-[WDM]: https://github.com/Maher4Ever/wdm

data/README.md

@@ -1,4 +1,4 @@
-# Listen [![Build Status](https://secure.travis-ci.org/guard/listen.png?branch=master)](http://travis-ci.org/guard/listen)
+# Listen [![Gem Version](https://badge.fury.io/rb/listen.png)](http://badge.fury.io/rb/listen) [![Build Status](https://secure.travis-ci.org/guard/listen.png?branch=master)](http://travis-ci.org/guard/listen) [![Dependency Status](https://gemnasium.com/guard/listen.png)](https://gemnasium.com/guard/listen) [![Code Climate](https://codeclimate.com/github/guard/listen.png)](https://codeclimate.com/github/guard/listen) [![Coverage Status](https://coveralls.io/repos/guard/listen/badge.png?branch=master)](https://coveralls.io/r/guard/listen)
 
 The Listen gem listens to file modifications and notifies you about the changes.
 
@@ -11,22 +11,50 @@ The Listen gem listens to file modifications and notifies you about the changes.
 * Detects file modification, addition and removal.
 * Checksum comparison for modifications made under the same second.
 * Allows supplying regexp-patterns to ignore and filter paths for better results.
-* Tested on all Ruby environments via [travis-ci](http://travis-ci.org/guard/listen).
+* Tested on all Ruby environments via [Travis CI](https://travis-ci.org/guard/listen).
 
 ## Install
 
-``` bash
-gem install listen
+### Using Bundler
+
+The simplest way to install Listen is to use Bundler.
+
+Add Listen to your Gemfile:
+
+```ruby
+group :development do
+  gem 'listen'
+end
+```
+
+and install it by running Bundler:
+
+```bash
+$ bundle
+```
+
+### Install the gem with RubyGems
+
+```bash
+$ gem install listen
+```
+
+### On Windows
+
+If your are on Windows and using Ruby MRI >= 1.9.2 you can try to use the [`wdm`](https://github.com/Maher4Ever/wdm) instead of polling.
+Please add the following to your Gemfile:
+
+```ruby
+require 'rbconfig'
+gem 'wdm', '>= 0.1.0' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
 ```
 
 ## Usage
 
 There are **two ways** to use Listen:
 
-1. Call `Listen.to` with either a single directory or multiple directories, then define the `change` callback in a block.
-2. Create a `listener` object and use it in an (ARel style) chainable way.
-
-Feel free to give your feeback via [Listen issues](https://github.com/guard/listen/issues)
+1. Block API: Call `Listen.to`/`Listen.to!` with either a single directory or multiple directories, then define the `change` callback in a block.
+2. "Object" API: Create a `listener` object and use it in a chainable way.
 
 ### Block API
 
@@ -52,10 +80,11 @@ listener = listener.latency(0.5)
 listener = listener.force_polling(true)
 listener = listener.polling_fallback_message(false)
 listener = listener.change(&callback)
-listener.start # blocks execution!
+listener.start
 ```
 
-### Chainable
+**Note**: All the "Object" API methods except `start`/`start!` return the listener
+and are thus chainable:
 
 ``` ruby
 Listen.to('dir/path/to/listen')
@@ -65,7 +94,7 @@ Listen.to('dir/path/to/listen')
       .force_polling(true)
       .polling_fallback_message('custom message')
       .change(&callback)
-      .start # blocks execution!
+      .start
 ```
 
 ### Pause/Unpause
@@ -74,35 +103,11 @@ Listener can also easily be paused/unpaused:
 
 ``` ruby
 listener = Listen.to('dir/path/to/listen')
-listener.start(false) # non-blocking mode
+listener.start   # non-blocking mode
 listener.pause   # stop listening to changes
 listener.paused? # => true
-listener.unpause
-listener.stop
-```
-
-## Listening to changes on multiple directories
-
-The Listen gem provides the `MultiListener` class to watch multiple directories and
-handle their changes from a single listener:
-
-```ruby
-listener = Listen::MultiListener.new('app/css', 'app/js')
-listener.latency(0.5)
-
-# Configure the listener to your needs...
-
-listener.start # blocks execution!
-````
-
-For an easier access, the `Listen.to` method can also be used to create a multi-listener:
-
-``` ruby
-listener = Listen.to('app/css', 'app/js')
-                 .ignore(%r{^vendor/}) # both js/vendor and css/vendor will be ignored
-                 .change(&assets_callback)
-
-listener.start # blocks execution!
+listener.unpause # start listening to changes again
+listener.stop    # stop completely the listener
 ```
 
 ## Changes callback
@@ -112,7 +117,7 @@ The registered callback gets invoked, when there are changes, with **three** par
 `modified_paths`, `added_paths` and `removed_paths` in that particular order.
 
 You can register a callback in two ways. The first way is by passing a block when calling
-the `Listen.to` method or when initializing a listener object:
+the `Listen.to`/`Listen.to!` method or when initializing a listener object:
 
 ```ruby
 Listen.to('path/to/app') do |modified, added, removed|
@@ -127,7 +132,7 @@ end
 
 ```
 
-The second way to register a callback is be calling the `change` method on any
+The second way to register a callback is by calling the `#change` method on a
 listener passing it a block:
 
 ```ruby
@@ -139,7 +144,7 @@ end
 listener = Listen.to('dir')
 listener.change(&callback) # convert the callback to a block and register it
 
-listener.start # blocks execution
+listener.start
 ```
 
 ### Paths in callbacks
@@ -168,7 +173,7 @@ Listen.to('/home/user/app/css', :relative_paths => true) do |modified, added, re
 end
 ```
 
-Passing the `:relative_paths => true` option won't work when listeneing to multiple
+Passing the `:relative_paths => true` option won't work when listening to multiple
 directories:
 
 ```ruby
@@ -181,29 +186,30 @@ end
 
 ## Options
 
-These options can be set through `Listen.to` params or via methods (see the "Object" API)
+All the following options can be set through the `Listen.to`/`Listen.to!` params
+or via ["Object" API](#object-api) methods:
 
 ```ruby
-:filter => /\.rb$/, /\.coffee$/                # Filter files to listen to via a regexps list.
-                                               # default: none
+:ignore => %r{app/CMake/}, /\.pid$/           # Ignore a list of paths (root directory or sub-dir)
+                                              # default: See DEFAULT_IGNORED_DIRECTORIES and DEFAULT_IGNORED_EXTENSIONS in Listen::DirectoryRecord
 
-:ignore => %r{app/CMake/}, /\.pid$/            # Ignore a list of paths (root directory or sub-dir)
-                                               # default: See DEFAULT_IGNORED_DIRECTORIES and DEFAULT_IGNORED_EXTENSIONS in Listen::DirectoryRecord
+:filter => /\.rb$/, /\.coffee$/               # Filter files to listen to via a regexps list.
+                                              # default: none
 
-:latency => 0.5                                # Set the delay (**in seconds**) between checking for changes
-                                               # default: 0.25 sec (1.0 sec for polling)
+:latency => 0.5                               # Set the delay (**in seconds**) between checking for changes
+                                              # default: 0.25 sec (1.0 sec for polling)
 
-:relative_paths => true                        # Enable the use of relative paths in the callback.
-                                               # default: false
+:force_polling => true                        # Force the use of the polling adapter
+                                              # default: none
 
-:force_polling => true                         # Force the use of the polling adapter
-                                               # default: none
+:polling_fallback_message => 'custom message' # Set a custom polling fallback message (or disable it with false)
+                                              # default: "Listen will be polling for changes. Learn more at https://github.com/guard/listen#polling-fallback."
 
-:polling_fallback_message => 'custom message'  # Set a custom polling fallback message (or disable it with `false`)
-                                               # default: "WARNING: Listen fallen back to polling, learn more at https://github.com/guard/listen#fallback."
+:relative_paths => true                       # Enable the use of relative paths in the callback.
+                                              # default: false
 ```
 
-### The patterns for filtering and ignoring paths
+### Note on the patterns for ignoring and filtering paths
 
 Just like the unix convention of beginning absolute paths with the
 directory-separator (forward slash `/` in unix) and with no prefix for relative paths,
@@ -217,40 +223,49 @@ and not `%r{/build/}`.
 
 Use `#filter!` and `#ignore!` methods to overwrites default patterns.
 
-### Non-blocking listening to changes
+## Blocking listening to changes
+
+Calling `Listen.to` with a block doesn't block the current thread. If you want
+to block the current thread instead until the listener is stopped (which needs
+to be done from another thread), you can use `Listen.to!`.
+
+Similarly, if you're using the "Object" API, you can use `#start!` instead of `#start` to block the
+current thread until the listener is stopped.
 
-Starting a listener blocks the current thread by default. That means any code after the
-`start` call won't be run until the listener is stopped (which needs to be done from another thread).
+Here is an example of using a listener in the blocking mode:
 
-For advanced usage there is an option to disable this behavior and have the listener start working
-in the background without blocking. To enable non-blocking listening the `start` method of
-the listener (be it `Listener` or `MultiListener`) needs to be called with `false` as a parameter.
+```ruby
+Listen.to!('dir/path/to/listen') # block execution
+
+# Code here will not run until the listener is stopped
+
+```
 
-Here is an example of using a listener in the non-blocking mode:
+Here is an example of using a listener started with the "Object" API in blocking mode:
 
 ```ruby
 listener = Listen.to('dir/path/to/listen')
-listener.start(false) # doesn't block execution
+listener.start! # block execution
 
-# Code here will run immediately after starting the listener
+# Code here will not run until the listener is stopped
 
 ```
 
-**note**: Using the `Listen.to` helper-method with a callback-block will always
-block execution. See the "Block API" section for an example.
+**Note**: Using the `Listen.to!` helper-method with or without a callback-block
+will always start the listener right away and block execution of the current thread.
 
 ## Listen adapters
 
 The Listen gem has a set of adapters to notify it when there are changes.
-There are 3 OS-specific adapters to support Mac, Linux, *BSD and Windows. These adapters are fast
-as they use some system-calls to implement the notifying function.
+There are 4 OS-specific adapters to support Mac, Linux, *BSD and Windows.
+These adapters are fast as they use some system-calls to implement the notifying function.
 
 There is also a polling adapter which is a cross-platform adapter and it will
 work on any system. This adapter is unfortunately slower than the rest of the adapters.
 
 The Listen gem will choose the best and working adapter for your machine automatically. If you
 want to force the use of the polling adapter, either use the `:force_polling` option
-while initializing the listener or call the `force_polling` method on your listener
+while initializing the listener or call the `#force_polling` method on your listener
 before starting it.
 
 ## Polling fallback
@@ -259,11 +274,12 @@ When a OS-specific adapter doesn't work the Listen gem automatically falls back
 Here are some things you could try to avoid the polling fallback:
 
 * [Update your Dropbox client](http://www.dropbox.com/downloading) (if used).
-* Increase latency. (Please [open an issue](https://github.com/guard/listen/issues/new) if you think that default is too low.)
+* Increase latency. (Please [open an issue](https://github.com/guard/listen/issues/new)
+if you think that default is too low.)
 * Move or rename the listened folder.
 * Update/reboot your OS.
 
-If your application keeps using the polling-adapter and you can't figure out why, feel free to [open an issue](https://github.com/guard/listen/issues/new) (and be sure to give all the details).
+If your application keeps using the polling-adapter and you can't figure out why, feel free to [open an issue](https://github.com/guard/listen/issues/new) (and be sure to [give all the details](https://github.com/guard/listen/blob/master/CONTRIBUTING.md)).
 
 ## Development [![Dependency Status](https://gemnasium.com/guard/listen.png?branch=master)](https://gemnasium.com/guard/listen)
 
@@ -273,16 +289,16 @@ If your application keeps using the polling-adapter and you can't figure out why
 Pull requests are very welcome! Please try to follow these simple rules if applicable:
 
 * Please create a topic branch for every separate change you make.
-* Make sure your patches are well tested. All specs run with `rake spec:portability` must pass.
+* Make sure your patches are well tested. All specs must pass on [Travis CI](https://travis-ci.org/guard/listen).
 * Update the [Yard](http://yardoc.org/) documentation.
-* Update the README.
-* Update the CHANGELOG for noteworthy changes.
+* Update the [README](https://github.com/guard/listen/blob/master/README.md).
+* Update the [CHANGELOG](https://github.com/guard/listen/blob/master/CHANGELOG.md) for noteworthy changes (don't forget to run `bundle exec pimpmychangelog` and watch the magic happen)!
 * Please **do not change** the version number.
 
 For questions please join us in our [Google group](http://groups.google.com/group/guard-dev) or on
 `#guard` (irc.freenode.net).
 
-## Acknowledgment
+## Acknowledgments
 
 * [Michael Kessler (netzpirat)][] for having written the [initial specs](https://github.com/guard/listen/commit/1e457b13b1bb8a25d2240428ce5ed488bafbed1f).
 * [Travis Tilley (ttilley)][] for this awesome work on [fssm][] & [rb-fsevent][].
@@ -311,5 +327,6 @@ For questions please join us in our [Google group](http://groups.google.com/grou
 [rb-inotify]: https://github.com/nex3/rb-inotify
 [stereobooster]: https://github.com/stereobooster
 [rb-fchange]: https://github.com/stereobooster/rb-fchange
+[rb-kqueue]: https://github.com/mat813/rb-kqueue
 [Yehuda Katz (wycats)]: https://github.com/wycats
 [vigilo]: https://github.com/wycats/vigilo