Skip to content

Installation

Steven Barnett edited this page Nov 15, 2018 · 1 revision

Installation

Direct Download / CDN

This method of installation has not been configured yet, but expect it soon! For contributors, what needs to be done:

  • Some type of build tool must be used to bundle and minify the code
  • The package.json must be updated so the bundled / minified version is pushed to unpkg

Optionally:

  • Once we're using a build tool, some code may be re-written to use ES6 features only if they're tested for performance. Both the native ES6 and the transpiled code must be as fast as the original (or faster)
  • Once we're using a build tool, multiple outputs may be defined:
    • A UMD module
    • A CommonJS module
    • An ES6 module
  • Once we're using a build tool, we may be able to auto-generate some docs. That'd be sweet

NPM

npm install --save jsindex

Yarn

yarn add jsindex

Dev Build

If you wish to contribute to JSIndex, or take advantage of the latest (untested) features, then you'll need to clone GitHub directly:

git clone https://github.com/stevendesu/jsindex.git
Clone this wiki locally