Skip to content

Commit b9acc2d

Browse files
committed
Shorten the README intro to avoid TLDR fatigue.
1 parent d86666a commit b9acc2d

File tree

1 file changed

+7
-19
lines changed

1 file changed

+7
-19
lines changed

README.md

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,18 @@
11
# jquery-migrate: Migrate older jQuery code to jQuery 1.9+
22

3-
This project can be used to detect and restore APIs, features or functionality that have been deprecated in jQuery and removed as of version 1.9. They include:
3+
This plugin can be used to detect and restore APIs or features that have been deprecated in jQuery and removed as of version 1.9.
4+
See the [warnings page](https://github.com/jquery/jquery-migrate/blob/master/warnings.md) for more information regarding messages the plugin generates.
5+
For more information about the changes made in jQuery 1.9, see the [upgrade guide](http://jquery.com/upgrade-guide/1.9/) and [blog post](http://blog.jquery.com/2013/01/15/jquery-1-9-final-jquery-2-0-beta-migrate-final-released/).
46

5-
* `jQuery.browser` [docs](http://api.jquery.com/jquery.browser)
6-
* `jQuery.fn.andSelf()` [docs](http://api.jquery.com/andSelf)
7-
* `jQuery.sub()` [docs](http://api.jquery.com/jquery.sub)
8-
* `jQuery.fn.toggle()` [docs](http://api.jquery.com/toggle-event/) (_event click signature only_)
9-
* `"hover"` pseudo-event name [docs](http://api.jquery.com/on/)
10-
* `jQuery.fn.error()` [docs](http://api.jquery.com/error/)
11-
* `ajaxStart, ajaxSend, ajaxSuccess, ajaxError, ajaxComplete, ajaxStop` global events on non-`document` targets [docs](http://api.jquery.com/category/ajax/global-ajax-event-handlers/)
12-
* Use of `attrChange`, `attrName`, `relatedNode`, `srcElement` on the `Event` object (use `Event.originalEvent.attrChange` etc. instead)
13-
* `jQuery.fn.attr()` using the `pass` argument (undocumented)
14-
* `jQuery.attrFn` object (undocumented)
15-
* `jQuery.fn.data()` data events (undocumented)
16-
* `jQuery.fn.data("events")` to retrieve event-related data (undocumented)
17-
18-
See the [warnings](https://github.com/jquery/jquery-migrate/blob/master/warnings.md) page for more information regarding messages the plugin generates.
19-
20-
In your web page, make sure to load this plugin *after* the script for jQuery:
7+
In your web page, load this plugin *after* the script for jQuery:
218

229
```html
23-
<script src="http://code.jquery.com/jquery-1.8.3.js"></script>
10+
<script src="http://code.jquery.com/jquery-1.9.0.js"></script>
2411
<script src="http://code.jquery.com/jquery-migrate-1.1.0.js"></script>
2512
```
2613

27-
The plugin can be included with versions of jQuery as old as 1.6.4 as a migration tool to identify potential upgrade issues. However, the plugin is only required for version 1.9 or higher to restore deprecated and removed functionality.
14+
The plugin can be included with versions of jQuery as old as 1.6.4 to identify potential upgrade issues via its JQMIGRATE console warnings.
15+
However, the plugin is only required for version 1.9.0 or higher to restore deprecated and removed functionality.
2816

2917
## Download
3018

0 commit comments

Comments
 (0)