Skip to content

Commit ee39f75

Browse files
committed
Adds readme.
1 parent 3d05889 commit ee39f75

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## About
2+
3+
jQuery-JSONP is a compact (1.8kB minified), yet feature-packed, alternative solution to jQuery's implementation of JSONP.
4+
5+
## Features
6+
7+
jQuery-JSONP features:
8+
* *error recovery* in case of network failure or ill-formed JSON responses,
9+
* precise *control over callback naming* and how it is transmitted in the URL,
10+
* multiple requests with the *same callback name running concurrently*,
11+
* *two caching mechanisms* (browser-based and page based),
12+
* the possibility to *manually abort* the request just like any other AJAX request,
13+
* a *timeout* mechanism.
14+
15+
jQuery-JSONP publishes a $.ajax()-like function called $.jsonp(): similarity ensures programmers get up-to-speed easily.
16+
17+
For instance, as of version 2.3.0, $.jsonp() returns a promise when used in conjunction with jQuery 1.5+.
18+
19+
## Compatibility
20+
21+
jQuery-JSONP has been tested and runs within all major browsers, namely:
22+
* *Internet Explorer 6+*
23+
* *Firefox 2+*
24+
* *Chrome 1+*
25+
* *Safari 3+*
26+
* *Opera 9+*
27+
28+
jQuery-JSONP has also been tested with jQuery 1.3.x up to 1.7.x
29+
30+
## Documentation
31+
32+
* [[API Documentation|API]]
33+
* [[Tips & Tricks|TipsAndTricks]]

0 commit comments

Comments
 (0)