From b3558f2f29676acce0b61cf831c1f5bb26ce321c Mon Sep 17 00:00:00 2001 From: Alan Souza Date: Tue, 2 Jun 2015 08:52:24 -0700 Subject: [PATCH] Enchanced README for bower. --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 43 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ceae3fd..aaa4721 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,43 @@ -# grommet-bower -Bower distribution of Grommet Library +# Grommet: The most advanced UX framework for enterprise apps + +**Note**: This is the Bower distribution of [Grommet](https://github.com/HewlettPackard/grommet). + +[![Slack](http://alansouzati.github.io/artic/img/slack-badge.svg)](https://grommet.slack.com) [![Build Status](https://magnum.travis-ci.com/HewlettPackard/grommet.svg?token=1waizR3WLGtkHJzKYxT8&branch=master)](https://magnum.travis-ci.com/HewlettPackard/grommet) [![Coverage Status](https://coveralls.io/repos/HewlettPackard/grommet/badge.svg?branch=master&t=Wle9Qs)](https://coveralls.io/r/HewlettPackard/grommet?branch=master) + + + +### Documentation + +Visit the [grommet.io](http://grommet.io/) website for more information. + +### Support / Contributing + +Before opening an issue or pull request, please read the [Contributing](http://grommet.io/docs/hpe/documentation/contributing) guide. + +### Hello World + + The quickest way to get started is to access the [Hello World](http://grommet.io/docs/hpe/documentation) page. + +### Install + + You can install Grommet using either of the methods below. + + For Bower users: + ``` + $ bower install grommet + ``` + + For NPM users: + ``` + $ npm install -g grommet + ``` + + Detailed instructions are on the [Get Started](http://grommet.io/docs/hpe/documentation/get-started) page. + +### Build + + Refer to the [Grommet Build Wiki](https://github.com/HewlettPackard/grommet/wiki/Building-Grommet) for instructions on how to install your local copy of Grommet. + +### Release History + + See the [Change Log](https://github.com/HewlettPackard/grommet/wiki/Change-Log). \ No newline at end of file