Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.32 KB

installation.md

File metadata and controls

40 lines (26 loc) · 1.32 KB
Raw

NPM

Vomit has been built with modularity in mind and for this reason, it is recommended to use NPM has the primary installation method. Vomit's code follows CommonJS standards and pairs nicely with module bundler such as Browserify or Webpack

# latest stable
$ npm install vomit

CLI

Vomit also comes with tools to test, visualize and author components. Using NPM, you can install the cli vomit with a simple command:

# install cli
$ npm link

# display vomit cli help
$ vomit --help

Standalone

If you don't use modules bundler, you can include vomit as a global variable by downloading the standalone version and include it with a script tag:

Development version
Production version

Important: because Vomit relies on ES6 syntax, you can only use standalone versions with the latest browsers or compile your code for next generation JavaScript.

Dev Build

git clone https://github.com/bredele/vomit.git
cd vomit
npm install
npm run build