Permalink
Browse files

Added README.

  • Loading branch information...
rauchg committed Jul 30, 2012
1 parent afbcfc3 commit 04bd02d2daf72209882f97ba25877bf0b7453edd
Showing with 59 additions and 0 deletions.
  1. +59 −0 README.md
View
@@ -0,0 +1,59 @@
+
+# superagent-queue
+
+Adds request queueing capabilities to superagent.
+
+## How to use
+
+```js
+var request = require('superagent');
+require('superagent-queue');
+
+// ordered get requests
+request
+ .post('/')
+ .send(1)
+ .queue('numbers')
+ .end(function(){});
+
+request
+ .post('/')
+ .send(2)
+ .queue('numbers')
+ .end(function(){});
+
+request
+ .post('/')
+ .send(3)
+ .queue('numbers')
+ .end(function(){});
+
+// parallel requests
+request.get('/normal', function(){});
+request.post('/normal', function(){});
+```
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2011 Guillermo Rauch <guillermo@learnboost.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

0 comments on commit 04bd02d

Please sign in to comment.