cat-api-npm/README.md

A wrapper for The Cat API.

# cat-api-npm
An npm wrapper for The Cat API (http://thecatapi.com).

## Getting Started
To install the package, download the package from npm using:

    npm install cat-api-npm

## Usage
Requests can be made to the API using the methods described in the module. The supported operations are:

    get(options, callback)
    vote(options, callback)
    getvotes(options, callback)
    favourite(options, callback)
    getfavourites(options, callback)
    report(options, callback)
    
    list(callback)
    
    getoverview(options, callback)

See the corresponding wiki pages for more information regarding the options and callback parameters.

## License
This package is licensed under the MIT license (see the LICENSE file for more information). I have neither created nor contributed to the development of The Cat API, and this package is not affiliated with its developers in any way.

## Release History

* 1.0.0 Initial release