README.md in guard-teaspoon-0.0.4 vs README.md in guard-teaspoon-0.8.0
- old
+ new
@@ -1,35 +1,46 @@
-Guard Teaspoon
+Guard-Teaspoon
==============
+
+[](http://badge.fury.io/rb/guard-teaspoon)
+[](https://gemnasium.com/modeset/guard-teaspoon)
[](https://travis-ci.org/modeset/guard-teaspoon)
[](https://codeclimate.com/github/modeset/guard-teaspoon)
+[](https://coveralls.io/r/modeset/guard-teaspoon?branch=master)
+<img src="https://raw.github.com/modeset/teaspoon/master/screenshots/logo_big.png" alt="Logo by Morgan Keys" align="right" />
+<sup>Logo by [Morgan Keys](http://www.morganrkeys.com/)</sup>
+
Guard-Teaspoon allows you to run [Teaspoon](https://github.com/modeset/teaspoon) using [Guard](https://github.com/guard/guard).
-Teaspoon is a Javascript test runner built on top of Rails. It can run tests in the browser, or headlessly using PhantomJS or with Selenium WebDriver. We recommend you check out the [installation steps for Teaspoon](https://github.com/modeset/teaspoon#installation), and [read about configuration](https://github.com/modeset/teaspoon#configuration).
+Teaspoon is a Javascript test runner built for Rails. It runs test in the browser or headless using PhantomJS or Selenium WebDriver. We recommend you check out the [installation steps for Teaspoon](https://github.com/modeset/teaspoon#installation), and [read about the configuration](https://github.com/modeset/teaspoon#configuration).
With Guard-Teaspoon you can start up Guard, make changes to your tests or implementation files, and the specs will be run automatically using Teaspoon. It behaves very similarly to guard-rspec.
-This project is still experimental...
+This project is still experimental, but is being worked on.
+## Developer Notice
+
+The version of guard-teaspoon will be bumped up to 0.8 to match what is current in teaspoon. The versions will stay in sync (at least in terms of a minor version) from now on so that it's clear which versions work together well.
+
+
## Table of Contents
1. [Installation](#installation)
2. [Usage](#usage)
3. [Configuring Guard](#configuring-guard)
## Installation
-Add it to your Gemfile. Like Teaspoon, in most cases you'll want to restrict it to the `:asset`, or `:development, :test` groups. You may also want to include one of the filesystem gems that [Guard suggests](https://github.com/guard/guard#efficient-filesystem-handling), and in our example we included `rb-fsevent`.
+Add it to your Gemfile. Like Teaspoon, in most cases you'll want to restrict it to the `:development, :test` groups.
```ruby
-group :assets do
+group :development, :test do
gem "teaspoon"
gem "guard-teaspoon"
- gem "rb-fsevent" # used by guard
end
```
Install Teaspoon using the install generator.
@@ -57,17 +68,17 @@
## Configuring Guard
In general this isn't very complicated, but if you have multiple suites setup in Teaspoon this can get a little complicated -- there's an expectation that you understand what you're doing in regards to using Guard.
-The default Guardfile will watch for any file changes within your `app/assets/javascripts` path and will attempt to resolve those file to a spec. If you're using QUnit, you can change this to be _test instead of _spec, or use js.coffee or coffee for file extensions, and you can use a more advanced regexp for other needs.
+The default Guardfile will watch for any file changes within your `app/assets/javascripts` path and will attempt to resolve those file to a spec. If you're using QUnit, you can change this to be `_test` instead of `_spec`, or use js.coffee or coffee for file extensions, and you can use a more advanced regexp for other needs.
Guardfile
```ruby
guard :teaspoon do
- watch(%r{app/assets/javascripts/(.+).js}) { |m| "#{m[1]}_spec" }
- watch(%r{/spec/javascripts/(.*)})
+ watch(%r{^app/assets/javascripts/(.+).js}) { |m| "#{m[1]}_spec" }
+ watch(%r{^spec/javascripts/(.*)})
end
```
### Specifying Teaspoon Environment
@@ -86,10 +97,10 @@
## License
Licensed under the [MIT License](http://creativecommons.org/licenses/MIT/)
-Copyright 2012 [Mode Set](https://github.com/modeset)
+Copyright 2014 [Mode Set](https://github.com/modeset)
## Make Code Not War
