Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
Kai Wood committed Feb 19, 2017
1 parent c41992e commit 4e13722
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# pnut-butter

## Installation

```bash
npm install pnut-butter --save
```

## Usage

Fetch the global timeline:

```javascript
const pnut = require('pnut');

pnut.global().then(data => {
console.log(data);
})
```

## Authentication

You can set your access token like this:

```javascript
const pnut = require('pnut');

pnut.token = ACCESS_TOKEN
pnut.global().then(data => {
console.log(data);
})
```

## Todo

- Leave alpha status

0 comments on commit 4e13722

Please sign in to comment.