README.md in rerun-0.8.0 vs README.md in rerun-0.8.1

- old
+ new

@@ -33,10 +33,19 @@ available to all your apps. (There really should be a better way to distinguish gems-as-libraries from gems-as-tools.) rvm @global do gem install rerun +The Listen gem looks for certain platform-dependent gems, and will complain if +they're not available. Unfortunately, Rubygems doesn't understand optional +dependencies very well, so you may have to install extra gems (and/or put them +in your Gemfile) to make Rerun work more smoothly on your system. +(Learn more at <https://github.com/guard/listen#listen-adapters>.) +For example, on Mac OS X, use + + gem install rb-fsevent + # Usage: rerun [options] [--] cmd For example, if you're running a Sinatra app whose main file is `app.rb`: @@ -139,15 +148,18 @@ * **r** -- restart (as if a file had changed) * **c** -- clear the screen * **x** or **q** -- exit (just like control-C) +If you're backgrounding or using Pry or a debugger, you might not want these +keys to be trapped, so use the `--background` option. + # Signals The current algorithm for killing the process is: -* send [SIGTERM](http://en.wikipedia.org/wiki/SIGTERM) +* send [SIGTERM](http://en.wikipedia.org/wiki/SIGTERM) (or the value of the `--signal` option) * if that doesn't work after 4 seconds, send SIGINT (aka control-C) * if that doesn't work after 2 more seconds, send SIGKILL (aka kill -9) This seems like the most gentle and unixy way of doing things, but it does mean that if your program ignores SIGTERM, it takes an extra 4 to 6 seconds to @@ -229,17 +241,19 @@ of Ruby nor config file syntax. # Why did you write this? I've been using [Sinatra](http://sinatrarb.com) and loving it. In order -to simplify their system, the Rat Pack just removed auto-reloading from +to simplify their system, the Rat Pack removed auto-reloading from Sinatra proper. I approve of this: a web application framework should be focused on serving requests, not on munging Ruby ObjectSpace for dev-time convenience. But I still wanted automatic reloading during development. Shotgun wasn't working for me (see above) so I spliced Rerun together out of code from Rspactor, FileSystemWatcher, and Shotgun --- with a heavy amount of refactoring and rewriting. +-- with a heavy amount of refactoring and rewriting. In late 2012 I +migrated the backend to the Listen gem, which was extracted from Guard, +so it should be more reliable and performant on multiple platforms. # Credits Rerun: [Alex Chaffee](http://alexchaffee.com), <mailto:alex@stinky.com>, <http://github.com/alexch/> @@ -256,11 +270,15 @@ * Jens B <https://github.com/dpree> * Andrés Botero <https://github.com/anbotero> * Dreamcat4 * <https://github.com/FND> * Barry Sia <https://github.com/bsia> +* Paul Rangel <https://github.com/ismell> # Version History + +* v0.8.1 + * bugfix release (#30 and #34) * v0.8.0 * --background option (thanks FND!) to disable the keyboard listener * --signal option (thanks FND!) * --no-growl option