From bbd6fabc304b0edc31780eb1f98dfc5bf53938a2 Mon Sep 17 00:00:00 2001 From: "Eric D. Helms" Date: Mon, 14 Apr 2014 15:42:42 -0400 Subject: [PATCH] Updating Bower ignores to ignore all but the dist/ and less/ directories for distribution. --- README.md | 33 +++++++++++++++++++++++++++++++++ bower.json | 9 ++++++--- 2 files changed, 39 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4712273829..10cb1eb3f1 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ This reference implementation of PatternFly is based on [Bootstrap v3](http://getbootstrap.com/). Think of PatternFly as a "skinned" version of Bootstrap with additional components and customizations. +## Install with Bower + +PatternFly can be installed and managed through Bower. To do so, either add `patternfly` as a dependency in your `bower.json` or run the following: + +``` +bower install patternfly +``` + ## Dependencies PatternFly includes a number of dependencies that are not committed to this repository. To add them, see "Install Bower Components". And make sure you keep them updated (see "Keeping Bower Components Updated"). @@ -82,6 +90,31 @@ PatternFlyIcons font is generated using [IcoMoon](http://icomoon.io/app). [Load The `tests/` directory contains HTML pages with component and pattern examples in order to facilitate development. Please consult the official documentation (see below) for full details on how to use PatternFly. +## Release + +The PatternFly library is released through the Bower package manager. This package manager determines available versions and installs based upon git tags. To release a new version version of PatternFly the version listed in `bower.json` needs to be updated and the repository tagged and pushed upstream. + +Update the version listed in `bower.json` by editing the file and changing the line: + +``` +"version": "" +``` + +Commit the version bump: + +``` +git commit -a -m "Version bump to " +``` + +Tag and push upstream (assuming you have commit access): + +``` +git tag +git push && git push --tags +``` + +The new version will now be automatically available via Bower. + ## Documentation See [https://www.patternfly.org](https://www.patternfly.org) and [http://getbootstrap.com/](http://getbootstrap.com/). diff --git a/bower.json b/bower.json index d22e44ea78..7cd5b83381 100644 --- a/bower.json +++ b/bower.json @@ -10,7 +10,11 @@ "bower_components", "app/components", "test", - "tests" + "tests", + "package.json", + "Gruntfile.js", + "PatternFlyIcons-webfont.json", + "README.md" ], "dependencies": { "bootstrap": "~3.1.1", @@ -19,6 +23,5 @@ "font-awesome": "~4.0.1", "html5shiv": "~3.7.0", "respond": "~1.3.0" - }, - "private": true + } }