From 8d730bd60707180ca48c15e7272afbd712b5af72 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jesu=CC=81s=20Pe=CC=81rez?= Date: Thu, 22 Jan 2015 18:21:26 +0100 Subject: [PATCH] README completed --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 1e403d19..a4e9c234 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ You may install this theme using Bower or Meteor: - Bower : `bower install bootstrap-material-design` - Meteor: `meteor add fezvrasta:bootstrap-material-design` +- NPM: `npm i bootstrap-material-design` If you prefer, you can include this framework in your project using our official CDN: @@ -189,3 +190,18 @@ Read more about [selectize.js](http://brianreavis.github.io/selectize.js/). ## Compatibility Currently, Material Design for Bootstrap supports Google Chrome (tested v37+), Mozilla Firefox (tested 30+), and Internet Explorer (tested 11+). Mobile browsers are not currently tested but they may work. + +###Browserify +This library is [CommonJS](http://www.commonjs.org/) compatible, so you can use it this way: + +```javascript +var jquery = require('jquery'); +require('bootstrap')(jquery); +require('bootstrap-material')(jquery); + +console.log('Is Bootstrap loaded?'); +console.log((typeof jquery().emulateTransitionEnd === 'function')); +console.log('Is Bootstrap Material loaded?'); +console.log(jquery().material !== undefined); +``` +NOTE: Until this [PR](https://github.com/twbs/bootstrap/pull/15640) is accepted in the main Bootstrap project this fork must be used: [https://github.com/eface2face/bootstrap-material-design](https://github.com/eface2face/bootstrap-material-design) \ No newline at end of file