Skip to content
This repository has been archived by the owner on Aug 25, 2018. It is now read-only.

Commit

Permalink
README: GET/POST functions, streaming notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jdub committed Oct 17, 2010
1 parent 4d9520f commit ddc6b81
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Expand Up @@ -22,9 +22,17 @@ It's early days for `node-twitter`, so I'm going to assume a fair amount of know
access_token_secret: 'STATE YOUR NAME'
});

### Basic OAuth-enticated GET/POST API

The convenience APIs aren't finished, but you can get started with the basics:

twit.get('/statuses/show/27593302936.json', {include_entities:true}, function(data) {
sys.puts(sys.inspect(data));
});

### REST API

Note that functions may be chained:
Note that all functions may be chained:

twit
.verifyCredentials(function (data) {
Expand All @@ -39,6 +47,8 @@ Note that functions may be chained:

### Streaming API

The stream() callback receives a Stream-like EventEmitter:

twit.stream('statuses/sample', null, function(stream) {
stream.on('data', function (data) {
sys.puts(sys.inspect(data));
Expand Down

0 comments on commit ddc6b81

Please sign in to comment.