simple-cw-node/README.md

A simple ChatWork API client for Node.js (UNOFFICIAL)

simple-cw-node
==============

A simple ChatWork API client for Node.js. ( **UNOFFICIAL** )

## Installation

```bash
$ npm install simple-cw-node
```

### Dependencies

* [superagent](https://github.com/visionmedia/superagent)
* [lodash](https://github.com/lodash/lodash)
* [underscore.deferred](https://github.com/wookiehangover/underscore.Deferred)

## API Document

[Official API Document](http://developer.chatwork.com/ja/)

[RAML](https://github.com/chatwork/api)

## Usage

The minimal you'll need to have is:

```js
var CW = require('simple-cw-node'),
    client = CW();

// initialize.
client.init({
    token: 'YOUR_LEGACY_TOKEN'
});

// in the case of OAuth
client.init({
    type: 'oauth',
    token: 'YOUR_OAUTH_TOKEN',
})

// get your info.
client.get('me', function (err, res) {
    console.log(res.body);
});

// create room.
client.post('rooms', {
    name: 'room',
    members_admin_ids: '123456789,987654321',
    description: 'description'
}, function (err, res) {
    console.log('created.');
});
```

### Deferred support

```js
var CW = require('simple-cw-node'),
    client = CW(),
    Deferred = client.Deferred;

// initialize.
client.init({ token: 'YOUR_TOKEN' });

// get your info.
client
    .get('me')
    .done(function (res) {
        console.log(res.body)
    })
    .fail(function (err) {
        console.error(err);
    });
```

## Author

* [astronaughts](https://twitter.com/astronaughts)