Skip to content

Commit 29b2c26

Browse files
committed
Update README.md
1 parent 011301a commit 29b2c26

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

‎README.md‎

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,37 @@
22

33
AngularJS directives for creating bootstrap material design components based on [bootstrap-material-design](http://fezvrasta.github.io/bootstrap-material-design/) css.
44

5-
This repo aims to support creating bootstrap material design components in pure Angular way - eliminate the dependency on jQuery as well as bootstraps JavaScript.
5+
###### This is a work in progress.
6+
7+
##Getting Started
8+
9+
This project is an AngularJS version of the aswesome [bootstrap material design](http://fezvrasta.github.io/bootstrap-material-design/). It removes the dependency on jQuery as well as Bootstrap's JavaScript and makes it easy to work with dynamic AngularJS components
10+
11+
###Dependencies:
12+
- [AngularJS](http://angularjs.org)
13+
- [Angular-messages](http://angularjs.org)
14+
- [Bootstrap](http://getbootstrap.com") (tested with version 3.3.6)
15+
- [Bootstrap Material Design CSS components](http://fezvrasta.github.io/bootstrap-material-design/) (bootstrap-material-design.css and ripples.css)
16+
- [UI Bootstrap](https://angular-ui.github.io/bootstrap/) (Optional: required for supporting bootstrap's JavaScript components)
17+
18+
###How to install:
19+
20+
run `bower install abm` to install via bower or grab the latest source from [Github](https://raw.githubusercontent.com/tilwinjoy/angular-bootstrap-material/master/dist/angular-bootstrap-material.js) and include it in your project after the dependencies.
21+
22+
Include `angularBootstrapMaterial` module in your application:
23+
24+
```js
25+
angular.module('app', ['angularBootstrapMaterial']);
26+
```
27+
28+
###CSS Related Stuff:
29+
This project doesn't do any CSS magic, all that comes from [Bootstrap material design](http://fezvrasta.github.io/bootstrap-material-design).
30+
For demos and documentation of typography, tables, icons etc refer the Bootstrap material design [documentation](http://fezvrasta.github.io/bootstrap-material-design)
31+
32+
###Demos
633

734
Visit http://tilwinjoy.github.io/angular-bootstrap-material/ for demos
835

9-
###### This is a work in progress.
36+
###Contributing
1037

1138
Any suggestions for improvement, bug reports and helping hands are very welcome.

0 commit comments

Comments
 (0)