UNPKG

rubber

Version:
71 lines (45 loc) 2.89 kB
# Rubber.js [![npm version](https://img.shields.io/npm/v/rubber.svg)](https://www.npmjs.com/package/rubber) [![license type](https://img.shields.io/npm/l/rubber.svg)](https://github.com/FreeAllMedia/rubber.git/blob/master/LICENSE) [![npm downloads](https://img.shields.io/npm/dm/rubber.svg)](https://www.npmjs.com/package/rubber) ![ECMAScript 6 & 5](https://img.shields.io/badge/ECMAScript-6%20/%205-red.svg) Shape new things. # Quality and Compatibility [![Build Status](https://travis-ci.org/FreeAllMedia/rubber.png?branch=master)](https://travis-ci.org/FreeAllMedia/rubber) [![Coverage Status](https://coveralls.io/repos/FreeAllMedia/rubber/badge.svg)](https://coveralls.io/r/FreeAllMedia/rubber) [![bitHound Score](https://www.bithound.io/github/FreeAllMedia/rubber/badges/score.svg)](https://www.bithound.io/github/FreeAllMedia/rubber) [![Dependency Status](https://david-dm.org/FreeAllMedia/rubber.png?theme=shields.io)](https://david-dm.org/FreeAllMedia/rubber?theme=shields.io) [![Dev Dependency Status](https://david-dm.org/FreeAllMedia/rubber/dev-status.svg)](https://david-dm.org/FreeAllMedia/rubber?theme=shields.io#info=devDependencies) *Every build and release is automatically tested on the following platforms:* ![node 0.12.x](https://img.shields.io/badge/node-0.12.x-brightgreen.svg) ![node 0.11.x](https://img.shields.io/badge/node-0.11.x-brightgreen.svg) ![node 0.10.x](https://img.shields.io/badge/node-0.10.x-brightgreen.svg) ![iojs 2.x.x](https://img.shields.io/badge/iojs-2.x.x-brightgreen.svg) ![iojs 1.x.x](https://img.shields.io/badge/iojs-1.x.x-brightgreen.svg) [![Sauce Test Status](https://saucelabs.com/browser-matrix/rubber.svg)](https://saucelabs.com/u/rubber) *If your platform is not listed above, you can test your local environment for compatibility by copying and pasting the following commands into your terminal:* ``` npm install rubber cd node_modules/rubber gulp test-local ``` # Installation Copy and paste the following command into your terminal to install Rubber: ``` npm install rubber --save ``` ## Import / Require ``` // ES6 import rubber from "rubber"; ``` ``` // ES5 var rubber = require("rubber"); ``` ``` // Require.js define(["require"] , function (require) { var rubber = require("rubber"); }); ``` # Getting Started Shape new things. # How to Contribute See something that could use improvement? Have a great feature idea? We listen! You can submit your ideas through our [issues system](https://github.com/FreeAllMedia/rubber/issues), or make the modifications yourself and submit them to us in the form of a [GitHub pull request](https://help.github.com/articles/using-pull-requests/). We always aim to be friendly and helpful. ## Running Tests It's easy to run the test suite locally, and *highly recommended* if you're using Rubber.js on a platform we aren't automatically testing for. ``` npm test ```