node-buxfer v0.1.2

node-buxfer

A Node.js wrapper for the Buxfer API

Install

node-buxfer is available on npm and as such, can be installed through npm with ease.

To install node-buxfer and add it to your package.json file, use the following command:

$ npm install --save node-buxfer

Documentation

The official buxfer documentation

Usage

In order to use node-buxfer you will need to generate an API token on the buxfer website.

Call this page with your credentials ang get the token

https://www.buxfer.com/api/login?userid=trent@nin.rock&password=reznor

Once you have this, add the library to your project with the following command:

$ npm install --save node-buxfer

Once installed you need to instantiate a new copy of node-buxfer in your application, like so:

var buxfer = require('node-buxfer'),
    api = new buxfer('[token]');

Note: replace token with your token.

Running the Tests

The tests are based on the jest module, which may be installed via npm. To run the tests make sure that the npm dependencies are installed by running npm install from the project directory.

create file tests/config.json from tests/config.sample.json with your values

{
    "token": "xxxxxxxxxx"
}

$ npm test

Issues

Please raise an issue on GitHub with as much information as possible and the steps to replicate (if possible).

LICENSE

MIT license. See the LICENSE file for details.

Fork me on github

Created by @ilbonzo