Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 2.58 KB

README.md

File metadata and controls

41 lines (26 loc) · 2.58 KB

Splatoon2.ink Node API Client

Build Status Coverage Status npm npm GitHub stars Documentation Status Join the chat at https://gitter.im/splatoon2-ink-node-api-client/Lobby Waffle.io - Columns and their card count Maintainability Test Coverage

An API client for Splatoon2.ink.

Installation

npm install splatoon2.ink-node-api-client

Usage

var client = require('splatoon2.ink-node-api-client');

var currentStages = client.getCurrentStages(); // Object containing regular, ranked, and league stages.

Tests

npm test

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

To install dependencies, run yarn.

Other

I am not responsible for usage of this API. This is only a client, and not the API itself. Caching is not implemented.