Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 1.44 KB

README.md

File metadata and controls

55 lines (41 loc) · 1.44 KB

athlib NPM version Build Status Dependency Status

A library of functions, data and schema for Athletics (i.e. Track and Field)

Installation

$ npm install --save athlib

Usage

Please note that this library is a work in progress and the functionality will be extended and changed without notice until a stable version can be released.

var athlib = require('athlib');
console.log(athlib.utils.normalizeGender('Male')) // == 'm'

Testing

Mocha is used for unit testing. Run the following command to run all test and generate the lcov report

$ npm test

or if you have mocha installed globally

$ npm install --global mocha
$ mocha

Linting

ESLint is used for code quality standards.

Install globally

$ npm install -g eslint

then run

$ eslint ./

License

Apache-2.0 © benjamintoomer

codecov