Skip to content

Commit

Permalink
Merge pull request #11 from ehelms/update-bower
Browse files Browse the repository at this point in the history
Updating Bower ignores to ignore all but the dist/ and less/ directories...
  • Loading branch information
rhamilto committed Apr 14, 2014
2 parents 713cc6c + bbd6fab commit 9401b22
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 3 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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").
Expand Down Expand Up @@ -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": "<new_version>"
```

Commit the version bump:

```
git commit -a -m "Version bump to <new_version>"
```

Tag and push upstream (assuming you have commit access):

```
git tag <new_version>
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/).
Expand Down
9 changes: 6 additions & 3 deletions bower.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -19,6 +23,5 @@
"font-awesome": "~4.0.1",
"html5shiv": "~3.7.0",
"respond": "~1.3.0"
},
"private": true
}
}

0 comments on commit 9401b22

Please sign in to comment.