README.md in requirejs_integrator-2.0.1 vs README.md in requirejs_integrator-3.0.1
- old
+ new
@@ -2,11 +2,11 @@
[](http://badge.fury.io/rb/requirejs_integrator)
## Assumptions
-* joins the `r.js` and its components into project dependencies
+* joins the [r.js][rjs] and its components into project dependencies
* provides the tasks for the assets management
* provides the default r.js config
## Requirements
@@ -24,22 +24,41 @@
Or install it yourself as:
$ gem install requirejs_integrator
+## Configuration
+
+Through `RequirejsIntegrator::Config` class:
+
+```ruby
+config = RequirejsIntegrator::Config.new(
+ "project_javascripts_dir" => "js_dir" # default: "javascripts"
+ "project_js_compressed_dir" => "jsc_dir" # default: "js"
+ "project_ui_dir" => "ui_dir" # default: "."
+ "project_public_dir" => "pub_dir" # default: "public"
+ "project_config_dir" => "conf" # default: "config"
+ "project_requirejs_config_file" => "b.js" # default: "build.js"
+)
+```
+
## Usage
Add to project's Rakefile:
-```
+```ruby
require 'requirejs_integrator'
+RequirejsIntegrator::Tasks.load(RequirejsIntegrator::Config.new)
```
-and list the available tasks:
+and list available tasks:
+```ruby
+bundle exec rake -T
+# rake ri:compile # Compile js
+# rake ri:config # Install default r.js config
```
-rake -T
-```
+
## Versioning
See [semver.org][semver]
## Contributing
@@ -49,5 +68,6 @@
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
[semver]: http://semver.org/
+[rjs]: http://requirejs.org/