README.markdown in terminal-notifier-guard-1.6.4 vs README.markdown in terminal-notifier-guard-1.7.0
- old
+ new
@@ -29,14 +29,35 @@
$ gem install terminal-notifier-guard
```
Or add it to your Gemfile:
+```ruby
+gem 'terminal-notifier-guard', '~> 1.6.1'
```
-$ gem 'terminal-notifier-guard', '~> 1.6.1'
+
+Then, add the notifier to your Guardfile:
+
+```ruby
+# Guardfile
+notification :terminal_notifier #, app_name: "MyApp ::", activate: 'com.googlecode.iTerm2'
```
+### Configure Binary Path
+
+You can override the binary path detection with an environment variable. This solves a problem where the default binary found by `which` is the Ruby gem version of `terminal-notifier`. This version is slow, especially in a Bundler environment.
+
+In this scenario we would much rather use the version installed by Homebrew at `/usr/local/bin/terminal-notifier` which is noticeably faster.
+
+This commit allows us to set an environment variable to explicitly specify the binary to use, like this:
+
+```bash
+export TERMINAL_NOTIFIER_BIN=/usr/local/bin/terminal-notifier
+```
+
+_When using guard to monitor test results in TDD, speed is of the essence. Using the right binary can save a half second or more during each test run, which doesn't seem like much but makes a big difference in productivity._
+
### OSX 10.8 users
As of version `1.6.1`, we no longer bundle notifiers binaries in this gem. Please revert to
version `1.5.3` for OSX 10.8 support.
@@ -80,5 +101,9 @@
## Contributors & Thanks to
- @alloy (For the terminal-notifier)
- @railsme (For a clean way to test for OSX version #15)
- @jamilbx (For support for local terminal-notifier command #8)
+- @mattbrictson (For adding support for the TERMINAL_NOTIFIER_BIN env var)
+- @goronfreeman (For the lovely icon set!)
+- @bbonamin (For fixing the license issue)
+- @croeck (For fixing the binary detection)