Skip to content

C
Challonge
Commit 845cc695 authored by Aaron Tidwell's avatar Aaron Tidwell
Browse files
Options

update readme with dev instructions

parent b38dd073
Show whitespace changes
Inline Side-by-side
Showing with 4 additions and 12 deletions
readme.md
View file @ 845cc695
...@@ -9,7 +9,7 @@ $ npm install challonge --save ...@@ -9,7 +9,7 @@ $ npm install challonge --save
### Get all tournaments on your account ### Get all tournaments on your account
```js ```js
var challonge = require('./node-challonge'); var challonge = require('challonge');
var client = challonge.createClient({ var client = challonge.createClient({
apiKey: '***yourAPIKey***' apiKey: '***yourAPIKey***'
...@@ -101,18 +101,10 @@ tournament: { tournament_type: 'single elimination' } ...@@ -101,18 +101,10 @@ tournament: { tournament_type: 'single elimination' }
$ npm test $ npm test
``` ```
## TODO ### Issue Tracking
1. validate required params
2. docs
3. tests
## Bugs in the API / docs
Some minor gatchas:
* server 500s if trying to finalize() a tournament that has not yet been start()ed Issues are tracked on github: https://github.com/Tidwell/node-challonge/issues
--- The [Zenhub Browser Plugin](https://www.zenhub.com/) is used to organize issues.
The structure of this api wrapper is ripped off from https://github.com/nodejitsu/nodejitsu-api The structure of this api wrapper is ripped off from https://github.com/nodejitsu/nodejitsu-api
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment