Skip to content
Browse files

Quick API stability notes

  • Loading branch information...
1 parent 64b06a7 commit 3f48b90bda698a6df0bb187880e7adb0e04fea05 @jdub committed
Showing with 5 additions and 5 deletions.
  1. +5 −5 README.md
View
10 README.md
@@ -12,7 +12,7 @@ Asynchronous Twitter client API for node.js
It's early days for `node-twitter`, so I'm going to assume a fair amount of knowledge for the moment. Better documentation to come as we head towards a stable release.
-### Setup
+### Setup API (stable)
var sys = require('sys'), twitter = require('node-twitter');
var twit = new twitter({
@@ -22,7 +22,7 @@ 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
+### Basic OAuth-enticated GET/POST API (stable)
The convenience APIs aren't finished, but you can get started with the basics:
@@ -30,7 +30,7 @@ The convenience APIs aren't finished, but you can get started with the basics:
sys.puts(sys.inspect(data));
});
-### REST API
+### REST API (unstable, may change)
Note that all functions may be chained:
@@ -45,11 +45,11 @@ Note that all functions may be chained:
}
);
-### Streaming API
+### Streaming API (stable)
The stream() callback receives a Stream-like EventEmitter:
- twit.stream('statuses/sample', null, function(stream) {
+ twit.stream('statuses/sample', function(stream) {
stream.on('data', function (data) {
sys.puts(sys.inspect(data));
});

0 comments on commit 3f48b90

Please sign in to comment.
Something went wrong with that request. Please try again.