Skip to content

Latest commit

 

History

History
68 lines (36 loc) · 2.1 KB

README.md

File metadata and controls

68 lines (36 loc) · 2.1 KB

Master

Build Status

Dependency Status

Dev Dependency Status

Coverage Status

NPM version

#reiterate 0.1.0 #

A modern iteration library.

Load

The library is the single JavaScript file reiterate.js (or reiterate.min.js, which is reiterate.js minified).

It can be loaded via a script tag in an HTML document for the browser

<script src='./relative/path/to/reiterate.js'></script>

or as a CommonJS, Node.js or AMD module using require.

For Node, put the reiterate.js file into the same directory as the file that is requiring it and use

var reiterate = require('./reiterate.js');

or put it in a node_modules directory within the directory and use require('reiterate).

To load with AMD loader libraries such as requireJS:

require(['reiterate'], function(reiterate) {
    // Use reiterate here in local scope. No global reiterate.
});

Test

The test directory contains the test scripts for reiterate.

The tests can be run with Node.

To test all the methods

$ npm test

Test your browser

Build

I.e. minify.

On command line

$ npm run-script minify

will create lib/reiterate.min.js from lib/reiterate.js.

Feedback

Feedback is welcome.

Licence

See LICENCE.