Skip to content

Changes the documentation to show the instantiated object isn't a class. #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alanjames1987 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Changes the documentation to show the instantiated object isn't a class. #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,32 +24,32 @@ node-bitlyapi uses Bitly's OAuth implementation, so you'll need to register an O
[Register a Bitly OAuth app](https://bitly.com/a/oauth_apps "Bitly OAuth Apps")

var BitlyAPI = require("node-bitlyapi");
var Bitly = new BitlyAPI({
var bitly = new BitlyAPI({
client_id: "Something",
client_secret: "Something"
});

You can then either authenticate using your username and password

Bitly.authenticate(username, password, function(err, access_token) {
bitly.authenticate(username, password, function(err, access_token) {
// Returns an error if there was one, or an access_token if there wasn't
});

or if you know your OAuth access_token, you can simply call:

Bitly.setAccessToken(access_token);
bitly.setAccessToken(access_token);

## The Bitly Object

Each of the public Bitly API endpoints are mapped and available with the following method signature

Bitly.[method name](parameters, callback(error, response){
bitly.[method name](parameters, callback(error, response){

});

For Example:

Bitly.shorten({longUrl:"https://github.com/nkirby/node-bitlyapi"}, function(err, results) {
bitly.shorten({longUrl:"https://github.com/nkirby/node-bitlyapi"}, function(err, results) {
// Do something with your new, shorter url...
});

Expand All @@ -65,7 +65,7 @@ To make navigating the Bitly API a bit easier, a handful of small wrapper object

Since the vast majority of Bitly's usage is through shortening, I've provided a simpler alternative to the standard Bitly.shorten mapping:

Bitly.shortenLink("https://github.com/nkirby/node-bitlyapi", function(err, results) {
bitly.shortenLink("https://github.com/nkirby/node-bitlyapi", function(err, results) {

});

Expand All @@ -75,18 +75,18 @@ The following objects are provided to wrap the API in a friendlier manner

#### BitlyUser

Bitly.user()
Bitly.user('login')
Bitly.user('login').getLinkHistory(null, function(err, results) {
bitly.user()
bitly.user('login')
bitly.user('login').getLinkHistory(null, function(err, results) {
// Gets the public link history of "login"
});

For more information about a BitlyUser - [Wiki](https://github.com/nkirby/node-bitlyapi/wiki/BitlyUser "BitlyUser")

#### BitlyLink

Bitly.link('http://bit.ly/1eOHYrA')
Bitly.link('http://bit.ly/1eOHYrA').getInfo(function(err, results) {
bitly.link('http://bit.ly/1eOHYrA')
bitly.link('http://bit.ly/1eOHYrA').getInfo(function(err, results) {

});

Expand Down