directdrinks-api

directdrinks

Install

probably easiest with npm

$ npm i directdrinks-api

or if you don't want to use npm just use the files

$ git clone (this repo)
$ npm i
$ npm run start (runs the tests)

To use the libary, the code required is in index.js (everything else is tests). entry.js provides a way for babel to be enabled. The 'start' script runs this file first(.babelrc is also needed). The library also has some dependencies (devDependencies are for tests and other dev scripts).

If you yourself are using babel for shiny import features in your browser environment (of course you are):

import {DirectDrinksData} from 'dir/to/folder/index';
//or with npm
import {DirectDrinksData} from 'directdrinks-api'
//use it in your code (read docs for more info)

Unfortunately, babel must be used with this library as there is no transpiled version.

dev scripts

start: runs tests in a node environment

lint: lints code.

doc: generates documentation as html files in "out" folder

Usage

See ./out/global.html for documentation. It is made by jsdoc. The 'doc' script compiles the documentation from index.js.

License

MIT © dan