Skip to content

Commit

Permalink
update readme with usage and license
Browse files Browse the repository at this point in the history
  • Loading branch information
groupsky committed Nov 10, 2016
1 parent 6b7a87c commit c1f79d3
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,31 @@
Contains as a json the configuration that is used by various project
to retrieve information from Hackafe's trello boards.

## Usage

### Node

```
npm install --save hackafe-trello-config
```

```
var boardId = require('hackafe-trello-config').boardId
```

### Remote

```
GET http://trello-config.hackafe.org/config.json
```

## Specification

The package contains a single file [config.json](config.json) formatted as
JSON, with embedded comments following the pattern: `"-//field": "comment"`.
This is to provide maximum compatibility with all the strict json parsers out
there.

## License

[ISC](LICENSE). Copyright (c) [Geno Rouspky](https://github.com/groupsky).

0 comments on commit c1f79d3

Please sign in to comment.