Skip to content

Commit 36ace7f

Browse files
author
Eleni Rundle
committed
Merge pull request #119 from dtaylor113/readme
Added "Using Angular-PatternFly In Your Application" section
2 parents 411e3e7 + 5a1b765 commit 36ace7f

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

README.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,6 @@ You have to install required software before you're able to use grunt:
2525

2626
bower install
2727

28-
Note: The 'patternfly.charts' module is not a dependency in the default angular 'patternfly' module.
29-
In order to use patternfly charts you must add 'patternfly.charts' as a dependency in your application.
30-
3128
You should have your environment ready now.
3229

3330
Angular-PatternFly can now be built with:
@@ -40,6 +37,39 @@ To see all the grunt tasks that are available:
4037
grunt help
4138
```
4239

40+
### Using Angular-PatternFly In Your Application
41+
42+
Note:
43+
44+
1. Add Angular and Angular-PatternFly as a dependencies for your project and you'll receive all the libraries you'll need:
45+
46+
$ bower install angular --save
47+
$ bower install angular-patternfly --save
48+
49+
2. Add the follwing CSS include to your HTML file(s):
50+
51+
<!-- Angular-PatternFly Styles -->
52+
<link rel="stylesheet" href="bower_components/angular-patternfly/dist/styles/angular-patternfly.min.css" />
53+
54+
3. Add the following script includes to your HTML file(s), adjusting where necessary to pull in only what you need:
55+
56+
<!-- Angular-PatternFly -->
57+
<script src="bower_components/angular-patternfly/dist/angular-patternfly.min.js"></script>
58+
59+
<!-- C3, D3 - Charting Libraries. Only required if you are using the 'patternfly.charts' module-->
60+
<script src="bower_components/patternfly/components/c3/c3.min.js"></script>
61+
<script src="bower_components/patternfly/components/d3/d3.min.js"></script>
62+
63+
4. (optional) The 'patternfly.charts' module is not a dependency in the default angular 'patternfly' module.
64+
In order to use patternfly charts you must add 'patternfly.charts' as a dependency in your application:
65+
66+
my-app.module.js:
67+
68+
angular.module('myApp', [
69+
'patternfly',
70+
'patternfly.charts'
71+
]);
72+
4373
## API documentation
4474

4575
The API documentation can be built with:

0 commit comments

Comments
 (0)