README.md in bower-rails-0.2.1 vs README.md in bower-rails-0.3.1
- old
+ new
@@ -1,56 +1,102 @@
bower-rails
===========
rake tasks for bower on rails. Dependency file is bower.json in Rails root dir.
+**Asset Pipeline**
+
+As of version 0.3.0 bower-rails installs components in the asset directory, rather than assets/javascripts. This is because some of these packages also include stylesheets, or images. As such you may have to add components to your asset pipeline.
+
+``` Ruby
+ # config/application.rb
+
+ config.assets.paths << Rails.root.join("lib", "assets", "components")
+ config.assets.paths << Rails.root.join("vendor", "assets", "components")
+```
+
**Requirements**
* [node](http://nodejs.org) ([on github](https://github.com/joyent/node))
-* [bower](https://github.com/twitter/bow) installed with npm
+* [bower](https://github.com/twitter/bow) (>= 0.9) installed with npm
**Install**
in Gemfile
``` Ruby
- gem 'bower-rails'
+ gem "bower-rails", "~> 0.3.1"
```
**Initialize**
To add an empty bower.json file to the project root.
``` Bash
rails g bower_rails:initialize
```
+##JSON configuration
-**Configuration**
-
The bower.json file is two seperate bower [component.js](https://github.com/twitter/bower#defining-a-package) files. Defining a package in lib and vendor will install those packages to the corresponding directories.
**example bower.json file**
``` javascript
{
"lib": {
"dependencies": {
"threex" : "git@github.com:rharriso/threex.git",
- "gsvpano.js" : "https://github.com/rharriso/GSVPano.js/blob/master/src/GSVPano.js"
- }
+ "gsvpano.js" : "https://github.com/rharriso/GSVPano.js/blob/master/src/GSVPano.js"
+ }
},
"vendor": {
"dependencies": {
"three.js" : "https://raw.github.com/mrdoob/three.js/master/build/three.js"
}
}
}
```
-**Available command
+**Available commands**
``` bash
rake bower:install #install js components
rake bower:update #update js components
-```
\ No newline at end of file
+```
+
+
+##Ruby DSL configuration
+
+The Ruby DSL configuration is a Jsfile with DSL syntax similar to Bundler
+
+
+**Example Jsfile**
+
+``` ruby
+assets_path "assets/javascript"
+
+# Puts files under ./vendor/assets/js
+group :vendor, :assets_path => "assets/js" do
+ js "jquery" # Assummes it's latests
+ js "backbone", "1.2"
+end
+
+# Puts files under ./lib/assets/javascript
+group :lib do
+ js "jquery"
+ js "backbone", "1.2"
+end
+```
+
+**Available commands with a Jsfile**
+
+``` bash
+ rake bower:dsl:install #install js components
+ rake bower:dsl:update #update js components
+```
+
+
+
+
+