Skip to content

Commit d437b21

Browse files
committed
Updating README to add a little more explaination on what the plugin actually does
1 parent 483da43 commit d437b21

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,10 @@ jQuery.ajaxQueue({
2020

2121
## Documentation
2222

23+
This pluging creates a new method which ensures only one AJAX request is running at a time. It waits for the previous request(s) to finish before starting a new one using jQuery's built in queue.
24+
2325
### `jQuery.ajaxQueue( options )`
24-
Takes the same parameters as [jQuery.ajax](http://api.jquery.com/jQuery.ajax), returns a promise. Note that the return value is not a `jqXHR`, but it will behave like one. The `abort()` method on the return value will remove the request from the queue if it has not begun, or pass it along to the jqXHR's abort method once the request begins.
26+
Takes the same options as [jQuery.ajax](http://api.jquery.com/jQuery.ajax), and returns a promise. The return value is not a `jqXHR`, but it will behave like one. The `abort()` method on the returned object will remove the request from the queue if it has not begun, or pass it along to the jqXHR's abort method once the request begins.
2527

2628
## Examples
2729
_(Coming soon)_

0 commit comments

Comments
 (0)