From 0f9db5eb70fbe4930a7cfeab42713f4cfe473040 Mon Sep 17 00:00:00 2001 From: slamborne Date: Sun, 24 Nov 2013 13:09:05 -0500 Subject: [PATCH 1/2] Added README.md with usage instructions --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d57339a --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +bootstrap-bower +=============== + +A repository to hold bootstrap releases for twitter's bower + + +**bootstrap-bower** includes two versions of [ui.bootstrap](https://github.com/angular-ui/bootstrap) compiled as single javascript files for faster bower integration. All that's needed is Bootstrap's CSS. + + +`ui.bootstrap.js` requires that you provide template files in their expected paths. +`ui.bootstrap.tpls.js` includes the default html templates in the javascript itself, which are then automatically added to the $templateCache. + + +## Installation + +Add either `ui.boostrap.js` or `ui-bootstrap-tpls.js` to your html file. + +Add `ui.bootstrap` as a dependency in your AngularJs module: + +```javascript +angular.module('myModule', ['ui.bootstrap']); +``` + + +Project files are also available through your favourite package manager: +* **Bower**: `bower install angular-ui-bootstrap-bower` From 1566c01aa98be70727173619970939b272e5f8e4 Mon Sep 17 00:00:00 2001 From: slamborne Date: Tue, 3 Dec 2013 17:47:31 -0500 Subject: [PATCH 2/2] Concise update --- README.md | 20 +++++--------------- 1 file changed, 5 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d57339a..5773f33 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,16 @@ bootstrap-bower =============== -A repository to hold bootstrap releases for twitter's bower +If you are using external templates, include `ui-boostrap.js`. -**bootstrap-bower** includes two versions of [ui.bootstrap](https://github.com/angular-ui/bootstrap) compiled as single javascript files for faster bower integration. All that's needed is Bootstrap's CSS. +If you want to use the included default templates, include `ui-boostrap-tpls.js`. +The templates are embedded in the javascript as html strings which are stored in $templateCache. +-- -`ui.bootstrap.js` requires that you provide template files in their expected paths. -`ui.bootstrap.tpls.js` includes the default html templates in the javascript itself, which are then automatically added to the $templateCache. - - -## Installation - -Add either `ui.boostrap.js` or `ui-bootstrap-tpls.js` to your html file. - -Add `ui.bootstrap` as a dependency in your AngularJs module: +Add `ui.bootstrap` as a dependency in your application: ```javascript angular.module('myModule', ['ui.bootstrap']); ``` - - -Project files are also available through your favourite package manager: -* **Bower**: `bower install angular-ui-bootstrap-bower`