Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 45 lines (35 sloc) 1.36 kb
e78ffdb @tanepiper Cleaned up, added LICENCE and updated readme. Version bump
authored
1 node-bitly - Bitly API for nodejs
49b49d0 @tanepiper Doc changes
authored
2 ====================
65be035 @tanepiper Initial commit
authored
3
9c8ecc7 @tanepiper Added travis ci image to readme
authored
4 [![Build Status](https://secure.travis-ci.org/tanepiper/node-bitly.png)](http://travis-ci.org/tanepiper/node-bitly)
5
e78ffdb @tanepiper Cleaned up, added LICENCE and updated readme. Version bump
authored
6 This module provides calls to the [Bitly](http://bitly.com) API for [Nodejs](http://nodejs.org).
7 For more information on the API request and responses visit the [Bitly API docs](http://code.google.com/p/bitly-api/wiki/ApiDocumentation)
65be035 @tanepiper Initial commit
authored
8
49b49d0 @tanepiper Doc changes
authored
9 Installation
10 ------------
15e9d5b @tanepiper Small readme update
authored
11 To install via NPM type the following: `npm install bitly`
65be035 @tanepiper Initial commit
authored
12
15e9d5b @tanepiper Small readme update
authored
13 You can also install via git by cloning: `git clone https://github.com/tanepiper/node-bitly.git /path/to/bitly`
d8fa002 @tanepiper Updated readme
authored
14
49b49d0 @tanepiper Doc changes
authored
15 Usage
16 -----
17 var Bitly = require('bitly');
18 var bitly = new Bitly('<YOUR USERNAME>', '<YOUR API KEY>');
19 bitly.shorten('https://github.com/tanepiper/node-bitly', function(err, response) {
20 if (err) throw err;
21
22 // See http://code.google.com/p/bitly-api/wiki/ApiDocumentation for format of returned object
23 var short_url = response.data.url
24
25 // Do something with data
26 });
27
e78ffdb @tanepiper Cleaned up, added LICENCE and updated readme. Version bump
authored
28 Tests
29 -----
30 To run tests type `npm test`
49b49d0 @tanepiper Doc changes
authored
31
32 Bit.ly Features
33 ---------------
e78ffdb @tanepiper Cleaned up, added LICENCE and updated readme. Version bump
authored
34 Currently this module does NOT support the OAuth features of the Bitly API. As such
35 this module is limited to the following API methods:
36
37 * shorten
38 * expand
39 * validate
40 * clicks / clicks_by_minute / clicks_by_day
41 * referrers
42 * countries
43 * bitly_pro_domain
44 * lookup
45 * info
Something went wrong with that request. Please try again.