From 33bb8be088d281a8001a42ac0aee5b34ba1f3e79 Mon Sep 17 00:00:00 2001 From: benjaminapetersen Date: Wed, 23 Aug 2017 11:05:37 -0400 Subject: [PATCH] fix(README.md): add examples to Git Commit Guidelines in README.md --- README.md | 49 ++++++++++++++++++++++++++++++------------------- 1 file changed, 30 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index b7d3fb1ac..2474d5d06 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ [![Join the chat at https://gitter.im/patternfly/angular-patternfly](https://badges.gitter.im/patternfly/angular-patternfly.svg)](https://gitter.im/patternfly/angular-patternfly?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -# AngularJS directives for [PatternFly](https://www.patternfly.org) +# AngularJS components for [PatternFly](https://www.patternfly.org) -This project will provide a set of common AngularJS directives for use with the PatternFly reference implementation. +This project will provide a set of common AngularJS components for use with the PatternFly reference implementation. * Web site: https://www.patternfly.org * API Docs: http://www.patternfly.org/angular-patternfly/#/api @@ -18,7 +18,7 @@ You have to install required software before you're able to use grunt: * Install Node.js - Find more information on [Node.js](http://nodejs.org/) - Angular Patternfly stays up to date with the Node LTS [Release Schedule](https://github.com/nodejs/LTS#lts_schedule). If you're using Angular Patternfly downstream, we suggest the use of an actively supported version of Node/NPM, although prior versions of Node may work. + Angular Patternfly stays up to date with the Node LTS [Release Schedule](https://github.com/nodejs/LTS#lts_schedule). If you're using Angular Patternfly downstream, we suggest the use of an actively supported version of Node/NPM, although prior versions of Node may work. * Install npm - If npm is not already installed with Node.js, you have to install it manually. Find more information on [NPM](https://www.npmjs.org/) @@ -55,7 +55,7 @@ Note: 2. Add the core Patternfly CSS and script includes to your HTML file(s): Please see: https://github.com/patternfly/patternfly/blob/master/QUICKSTART.md - + Alternatively, the minimum you will need: @@ -78,24 +78,24 @@ Note: ```html - + - + - + ``` 5. (optional) The 'patternfly.charts' module is not a dependency in the default angular 'patternfly' module. In order to use patternfly charts you must add it as a dependency in your application: - + ```javascript my-app.module.js: - + angular.module('myApp', [ 'patternfly', 'patternfly.charts' @@ -111,10 +111,10 @@ Note: 6. (optional) The 'patternfly.table' module is not a dependency in the default angular 'patternfly' module. In order to use pfTableView, you must add 'patternfly.table' as a dependency in your application: - + ```javascript my-app.module.js: - + angular.module('myApp', [ 'patternfly', 'patternfly.table' @@ -128,13 +128,13 @@ Note: Add the following CSS includes to your HTML file(s): - + ```html ``` Add the following Javascript includes to your HTML file(s): - + ```html @@ -144,10 +144,10 @@ Note: ``` 7. (optional) The 'patternfly.canvas' module is not a dependency in the default angular 'patternfly' module. In order to use pfCanvasEditor or pfCanvas, you must add 'patternfly.canvas' as a dependency in your application: - + ```javascript my-app.module.js: - + angular.module('myApp', [ 'patternfly', 'patternfly.canvas' @@ -162,7 +162,7 @@ Note: ``` Add the following Javascript includes to your HTML file(s): - + ```html @@ -176,7 +176,7 @@ Note: Also, the canvas background grid image is located in 'node_modules/angular-patternfly/dist/imgs/canvas-dot-grid.png' please copy this image to your application's main images directory and reference it by overridding the '.canvas' css class: - + ```html