Skip to content
This repository was archived by the owner on May 29, 2019. It is now read-only.

Commit 2c9dc05

Browse files
docs(README): add installation instructions
1 parent 52ea341 commit 2c9dc05

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

Diff for: README.md

+18
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,23 @@
88

99
Do you want to see directives in action? Visit http://angular-ui.github.com/bootstrap/!
1010

11+
## Installation
12+
13+
Installation is easy as angular-ui-bootstrap has minimal dependencies - only the AngularJS and Bootstrap's CSS are required.
14+
After downloading dependencies (or better yet, referencing them from your favourite CDN) you need to download build version of this project. All the files and their purposes are described here:
15+
https://github.com/angular-ui/bootstrap/tree/gh-pages#build-files
16+
Don't worry, if you are not sure which file to take, opt for `ui-bootstrap-tpls-[version].min.js`.
17+
18+
When you are done downloading all the dependencies and project files the only remaining part is to add dependencies on the `ui.bootstrap` AngularJS module:
19+
20+
```javascript
21+
angular.module('myModule', ['ui.bootstrap']);
22+
```
23+
24+
Project files are also available through your favourite package manager:
25+
* **Bower**: `bower install angular-bootstrap`
26+
* **NuGet**: https://nuget.org/packages/Angular.UI.Bootstrap/
27+
1128
## Project philosophy
1229

1330
### Native, lightweight directives
@@ -58,5 +75,6 @@ Check the Grunt build file for other tasks that are defined for this project
5875
* push changes
5976
* switch back to the `main branch` and modify `package.json` to bump up version for the next iteration
6077
* commit (`chore(release): starting [versio number]`) and push
78+
* publish Bower and NuGet packages
6179

6280
Well done! (If you don't like repeating yourself open a PR with a grunt task taking care of the above!)

0 commit comments

Comments
 (0)