README.md in pace_rails-0.0.3 vs README.md in pace_rails-0.0.4
- old
+ new
@@ -1,9 +1,12 @@
-# PaceRails
+# pace_rails
-TODO: Write a gem description
+This is basically a ruby gem for asset pipeline which include the version 0.4.3 od the awesome [Pace][Pace] library.
+- [Original Library][OL]
+- [Demo][Demo]
+
## Installation
Add this line to your application's Gemfile:
gem 'pace_rails'
@@ -16,14 +19,26 @@
$ gem install pace_rails
## Usage
-TODO: Write usage instructions here
+You basically have to add the required.
+In your `application.js.coffee` (or just `application.js`) which is located at `app/assets/javascripts/application.js`:
+
+ //= require pace
+
+Also, place the following in your `application.css.scss` file which is located at `app/assets/stylesheets/application.css`:
+
+ *= require pace/
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
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
+
+[Pace]: http://github.hubspot.com/pace/ "Pace Documentation"
+[OL]: https://github.com/HubSpot/pace "Pace Github Repo"
+[Demo]: http://github.hubspot.com/pace/docs/welcome/ "Pace Demo"
\ No newline at end of file