pokeoneapi.js v0.0.4
Welcome!
Welcome to the pokeoneapi.js v0.0.3 documentation.
v0.0.3 is still very much a work-in-progress, as we're aiming to make it the best it can possibly be before releasing. Only use it if you are fond of living life on the bleeding edge.
About
pokeoneapi.js is a powerful Node.js module that allows you to interact with the PokéOne API very easily.
In the future we hope to be:
- Object-oriented
- Predictable abstractions
- Performant
- 100% coverage of the PokéOne API
Installation
Node.js 8.0.0 or newer is required.
npm install pokeoneapi.js
Example usage
const Router = require('pokeoneapi.js');
const API = new Router().api;
API.usersonline.then(console.log);
Contributing
Before creating an issue, please ensure that it hasn't already been reported/suggested.
See the contribution guide if you'd like to submit a PR.
Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official Rising Phoenix Discord Server.
Credits
- BigBrainAFK (for most of the code)
- Discord.JS (for travis, the templates and the nice docs)