@scapers/rs-api
v1.2.0
Published
[![Travis](https://img.shields.io/travis/scapers/rs-api.svg)](https://travis-ci.org/scapers/rs-api) [![Coveralls](https://img.shields.io/coveralls/scapers/rs-api.svg)](https://coveralls.io/github/scapers/rs-api) [![Dev Dependencies](https://david-dm.org/s
Downloads
6
Readme
RS-API
Introduction
@scapers/rs-api
is an open source wrapper, written with TypeScript using the TypeScript library starter, for the popular MMORPG RuneScape.
NOTE: This package is a TypeScript rewrite of rs-api
Installation
npm install @scapers/rs-api
Usage
Documentation can be found at here
Contribution
All .ts
files are found in the src
folder. The project is hooked in to scripts via the package.json
scripts, such as build
, test
, commit
, ect. See NPM scripts section below for more details.
This project is set up using git-cz
. As such, upon committing, use npm run commit
and fill the template out.
NPM scripts
npm t
: Run test suitenpm start
: Runnpm run build
in watch modenpm run test:watch
: Run test suite in interactive watch modenpm run test:prod
: Run linting and generate coveragenpm run build
: Generate bundles and typings, create docsnpm run lint
: Lints codenpm run commit
: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)