README.md in rack-jquery_ui-0.0.5 vs README.md in rack-jquery_ui-1.0.0
- old
+ new
@@ -5,15 +5,15 @@
### Build status ###
Master branch:
[](http://travis-ci.org/yb66/rack-jquery_ui)
-## Why? ##
+### Why? ###
I get tired of copy and pasting and downloading and moving… jQuery files and script tags etc. This does it for me (along with https://github.com/yb66/rack-jquery), and keeps version management nice 'n' easy.
-## Usage ##
+### Usage ###
Have a look in the examples directory, but here's a snippet.
* Install it (see below)
* `require 'rack/jquery_ui'`.
@@ -28,19 +28,19 @@
It also adds in a bit of javascript that will load in a locally kept version of jQuery, just incase the CDN is unreachable. The script will use the "/js/jquery-ui/1.10.1/jquery-ui.min.js" path (or, instead of 1.10.1, whatever is in {Rack::JQuery::VERSION}). You can change the "/js" bit if you like (see the docs).
That was easy.
-## Note ##
+### Note ###
You have to have loaded jQuery _before_ using the CDN helper, as jQuery-UI relies on it. I've already mentioned [Rack::JQuery](https://github.com/yb66/rack-jquery) which you can use to do this, or load the script however you like. Just remember that it needs to be there.
-## Version numbers ##
+### Version numbers ###
This library uses [semver](http://semver.org/) to version the **library**. That means the library version is ***not*** an indicator of quality but a way to manage changes. The version of jQuery-UI can be found in the lib/rack/jquery_ui/version.rb file, or via the {Rack::JQueryUI::JQUERY_UI_VERSION} constant.
-## Installation
+### Installation ###
Add this line to your application's Gemfile:
gem 'rack-jquery_ui'
@@ -50,12 +50,16 @@
Or install it yourself as:
$ gem install rack-jquery_ui
-## Contributing
+### 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
+
+### Licence ###
+
+See the LICENCE.txt file.