Add installation instructions to README.

tkem · tkem · commit dc7cd9774311 · 2014-09-19T06:52:47.000+02:00
diff --git a/Changes b/Changes
@@ -1,55 +1,78 @@
-Revision history for jQuery Timeout Plugin
+1.3.6 2014-09-14
+----------------
 
-1.3.5   2014-09-14
+- Add installation instructions to README.
 
-        - Fix `Timeout.reset()` handling of new delay.
 
-        - Fix `jQuery.timeoutWith()` context handling.
+1.3.5 2014-09-14
+----------------
 
-        - Fix jshint warnings.
+- Fix `Timeout.reset()` handling of new delay.
 
-1.3.4   2014-09-14
+- Fix `jQuery.timeoutWith()` context handling.
 
-        - Exclude bower.json from Bower ignores.
+- Fix jshint warnings.
 
-1.3.3   2014-09-14
 
-        - Register with Bower.
+1.3.4 2014-09-14
+----------------
 
-1.3.2   2014-09-14
+- Exclude bower.json from Bower ignores.
 
-        - Build using Grunt.
 
-        - Update QUnit to v1.15.0.
+1.3.3 2014-09-14
+----------------
 
-1.3.1   2014-03-27
+- Register with Bower.
 
-        - Update QUnit to v1.14.0.
 
-        - Add Changes.
+1.3.2 2014-09-14
+----------------
 
-        - Add license information to README.
+- Build using Grunt.
 
-1.3.0   2014-01-02
+- Update QUnit to v1.15.0.
 
-        - Add `Timeout.reset()`.
 
-1.2.1   2013-12-29
+1.3.1 2014-03-27
+----------------
 
-        - Fix callback context.
+- Update QUnit to v1.14.0.
 
-1.2.0   2013-12-20
+- Add Changes.
 
-        - Move repository to GitHub,
+- Add license information to README.
 
-        - Add `jQuery.timeoutWith()`, `jQuery.clearWith()`.
 
-        - Add QUnit tests.
+1.3.0 2014-01-02
+----------------
 
-1.1.0   2011-08-20
+- Add `Timeout.reset()`.
 
-        - Add optional args to `jQuery.timeout()`.
 
-1.0.0   2011-04-02
+1.2.1 2013-12-29
+----------------
 
-        - Initial release.
+- Fix callback context.
+
+
+1.2.0 2013-12-20
+----------------
+
+- Move repository to GitHub,
+
+- Add `jQuery.timeoutWith()` and `Timeout.clearWith()`.
+
+- Add QUnit tests.
+
+
+1.1.0 2011-08-20
+----------------
+
+- Add optional args to `jQuery.timeout()`.
+
+
+1.0.0 2011-04-02
+----------------
+
+- Initial release.
diff --git a/README.md b/README.md
@@ -2,10 +2,9 @@
 
 **jQuery 1.5** introduced the [Deferred Object][1] to register
 callbacks for asynchronous events.  Although the jQuery documentation
-contains examples on how to use Deferred objects with the native
-[`window.setTimeout()`][2] and [`window.clearTimeout()`][3] functions,
-jQuery does not provide a simple interface for timer-based Deferreds
-yet.
+contains [examples][2] on how to use Deferred objects with the native
+`window.setTimeout()` and `window.clearTimeout()` functions, jQuery
+does not provide a simple interface for timer-based Deferreds.
 
 This plugin provides the two functions `jQuery.timeout()` and
 `jQuery.timeoutWith()` that create a Deferred object which is resolved
@@ -14,6 +13,26 @@ Deferred's Promise and provides additional methods for clearing and
 resetting pending timeouts.
 
 
+## Getting Started
+
+Most easily, the plugin can be installed via [Bower][5]:
+
+    bower install jquery-timeout
+
+To build and install from source, you need to have [npm][6] and
+[grunt][7] installed.  In the repository's root directory, run:
+
+    npm install
+    grunt test
+    grunt dist
+
+Either way, uncompressed and minified JavaScript files for inclusion
+in your project will be available in the `dist` directory:
+
+    dist/jquery.timeout.js
+    dist/jquery.timeout.min.js
+
+
 ## API Documentation
 
 ### jQuery.timeout( delay [, args... ] )
@@ -102,6 +121,8 @@ Licensed under the [MIT License][4].
 
 
 [1]: http://api.jquery.com/category/deferred-object/
-[2]: http://developer.mozilla.org/en/docs/Web/API/window.setTimeout
-[3]: http://developer.mozilla.org/en/docs/Web/API/window.clearTimeout
+[2]: http://learn.jquery.com/code-organization/deferreds/examples
 [4]: http://raw.github.com/tkem/jquery-timeout/master/LICENSE
+[5]: http://bower.io/
+[6]: http://www.npmjs.org/
+[7]: http://gruntjs.com/
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "jquery-timeout",
-    "version": "1.3.5",
+    "version": "1.3.6",
     "title": "jQuery Timeout Plugin",
     "description": "Simple, yet elegant jQuery.Deferred wrapper for window.setTimeout() and window.clearTimeout().",
     "keywords":  ["timeout", "deferred", "promise", "delay"],

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "jquery-timeout",`
`3`		`- "version": "1.3.5",`
	`3`	`+ "version": "1.3.6",`
`4`	`4`	`"title": "jQuery Timeout Plugin",`
`5`	`5`	`"description": "Simple, yet elegant jQuery.Deferred wrapper for window.setTimeout() and window.clearTimeout().",`
`6`	`6`	`"keywords": ["timeout", "deferred", "promise", "delay"],`