README.md in rack-jquery_ui-1.0.2 vs README.md in rack-jquery_ui-1.1.0

- old
+ new

@@ -23,11 +23,11 @@ <pre><code> %head = Rack::JQueryUI.cdn </code></pre> -Now you have the script tags to Google's CDN in the head (you can also use Media Temple or Microsoft, see the docs). +Now you have the script tags to Google's CDN in the head (you can also use Media Temple or Microsoft, or Cloudflare, see the docs). 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. @@ -35,10 +35,26 @@ 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 ### -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. +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. + +On top of that, version numbers will also change when new releases of jQuery UI are supported. + +* If jQuery UI makes a major version jump, then this library will make a ***minor*** jump. That is because the API for the library has not really changed, but it is *possibly* a change that will break things. +* If jQuery UI makes a minor version jump, then so will this library, for the same reason as above. +* I doubt point releases will be followed, but if so, it will also precipitate a minor jump in this library's version number. That's because even though jQuery UI feel it's a point release, I'm not them, my responsibility is to users of this library and I'll take the cautious approach of making it a minor version number change. + +As an example, if the current library version was 1.0.0 and jQuery UI was at 2.0.0 and I made a change that I felt was major and breaking (to the Ruby library), I'd bump Rack::JQueryUI's version to 2.0.0. That the version numbers match between Rack::jQuery_UI and the jQuery UI script is of no significance, it's just coincidental. +If then jQuery UI went to v2.1.0 and I decided to support that, I'd make the changes and bump Rack::JQueryUI's version to 2.1.0. That the version numbers match between Rack::jQuery_UI and the jQuery UI script is of no significance, it's just coincidental. +If then I made a minor change to the library's API that could be breaking I'd bump it to 2.2.0. +If I then added some more instructions I'd bump Rack::JQueryUI's version to 2.2.1. +If then jQuery UI released version 3.0.0, I'd add it to the library, and bump Rack::JQueryUI's version to 2.3.0. + +Only one version of jQuery UI will be supported at a time. This is because the fallback script is shipped with the gem and I'd like to keep it as light as possible. It's also a headache to have more than one. + +So basically, if you want to use a specific version of jQuery UI, look for the library version that supports it via the {Rack::JQueryUI::JQUERY_UI_VERSION} constant. Don't rely on the version numbers of *this* library to tell you anything other than compatibility between versions of this library. ### Installation ### Add this line to your application's Gemfile: