Permalink
Browse files

link to twitter docs in the readme

  • Loading branch information...
1 parent 5bad1bb commit f87fe03dbc732a175ad3bf78c3f5adfde03541ed @technoweenie technoweenie committed Mar 15, 2010
Showing with 7 additions and 1 deletion.
  1. +7 −1 README.md
View
@@ -26,7 +26,9 @@ See the [streaming API docs][api-docs] for examples of the limit and delete comm
## Usage
+ // twitter-node does not modify GLOBAL, that's so rude
var TwitterNode = require('twitter-node').TwitterNode;
+
// you can pass args to create() or set them on the TwitterNode instance
var twit = new TwitterNode({
user: 'username',
@@ -45,10 +47,14 @@ See the [streaming API docs][api-docs] for examples of the limit and delete comm
// follow tweets from NYC
twit.location(-74, 40, -73, 41)
+ // http://apiwiki.twitter.com/Streaming-API-Documentation#QueryParameters
twit.params['count'] = 100;
- twit.headers['User-Agent'] = 'whatever';
+
+ // http://apiwiki.twitter.com/Streaming-API-Documentation#Methods
twit.action = 'sample'; // 'filter' is default
+ twit.headers['User-Agent'] = 'whatever';
+
twit
.addListener('tweet', function(tweet) {
sys.puts("@" + tweet.user.screen_name + ": " + tweet.text);

0 comments on commit f87fe03

Please sign in to comment.