challonge

Full Documentation on GH Pages

Usage

$3

``bash
$ npm install challonge --save
`

$3

`js
const challonge = require('challonge');

const client = challonge.createClient({
apiKey: 'yourAPIKey'
});

client.tournaments.index({
callback: (err, data) => {
console.log(err, data);
}
});

`

$3


`js
const challonge = require('challonge');

// create a new instance of the client
const client = challonge.createClient({
apiKey: 'yourAPIKey',
});

// create a tournament
client.tournaments.create({
tournament: {
name: 'new_tournament_name',
url: 'new_tournament_url',
tournamentType: 'single elimination',
},
callback: (err, data) => {
console.log(err, data);
}
});
`

API Client

The wrapper is organized into resource.method to match the API

For API calls that require nested params (eg: http://api.challonge.com/v1/documents/tournaments/create) properties should be specified as a nested object:

`js
{
tournament: {
name: 'new_tournament_name',
url: 'new_tournament_url',
tournamentType: 'single elimination',
},
callback: (err, data) => {}
}
`

All properties can be specified camelCase instead of using under_scores Both of the following are valid:

`js
tournament: { tournamentType: 'single elimination' }
`
`js
tournament: { tournament_type: 'single elimination' }
`

Development

$3

`bash
$ git clone https://github.com/Tidwell/node-challonge
$ cd node-challonge
$ npm install
`

$3


`bash
$ npm test
`

$3

`bash
$ npm run-script format
`

`bash
$ npm run-script lint
`

$3

`bash
$ npm run-script integrate
`

$3

Issues are tracked on github: https://github.com/Tidwell/node-challonge/issues

The Zenhub Browser Plugin is used to organize issues.

The structure of this api wrapper is ripped off from https://github.com/nodejitsu/nodejitsu-api




$3

master is the active development branch

live` is the latest published build on npm