README.md in barista-0.5.0 vs README.md in barista-0.5.1
- old
+ new
@@ -12,15 +12,15 @@
If you're using Jammit, this means you can simple run a rake task (`rake barista:brew` before running jammit) and
your coffeescripts will be automatically provided, ready for bundling.
To add to your project, simply add:
- gem 'barista', '>= 0.2.1'
+ gem 'barista', '>= 0.5.0'
To your Gemfile and run bundle install.
-As you place .coffee files in app/scripts, it will automatically handle them for you.
+As you place .coffee files in app/coffeescripts, it will automatically handle them for you.
Please note that for Jammit compatibility etc, by default in test and dev mode it will
automatically compile all coffeescripts that have changed before rendering the page.
Barista require rails 3+ (but patches for Rails 2 will be accepted.)
@@ -59,20 +59,25 @@
Barista lets you hook into the compilation at several stages. Namely:
* before compilation
* after compilation
* after compilation fails
+* after compilation complete
To hook into these hooks, you can use like so:
* `Barista.before_compilation { |path| puts "Barista: Compiling #{path}" }`
* `Barista.on_compilation { |path| puts "Barista: Successfully compiled #{path}" }`
* `Barista.on_compilation_with_warning { |path, output| puts "Barista: Compilation of #{path} had a warning:\n#{output}" }`
* `Barista.on_compilation_error { |path, output| puts "Barista: Compilation of #{path} failed with:\n#{output}" }`
+* `Barista.on_compilation_complete { puts "Barista: Successfully compiled all files" }`
-
These allow you to do things such as notify on compilation, automatically
perform compression post compilation and a variety of other cool things.
+
+An excellent example of these hooks in use is [barista\_growl](http://github.com/TrevorBurnham/barista_growl),
+by Trevor Burnham - a gem perfect for development purposes that automatically shows growl messages
+on compilation.
## Configuration ##
Please note that barista lets you configure several options. To do this,
it's as simple as setting up an initializer with:
\ No newline at end of file