1 | # Grommet: The most advanced UX framework for enterprise apps
|
2 |
|
3 | [![Slack](http://alansouzati.github.io/artic/img/slack-badge.svg)](http://slackin.grommet.io) [![Build Status](https://api.travis-ci.org/grommet/grommet.svg)](https://travis-ci.org/grommet/grommet) [![Coverage Status](https://coveralls.io/repos/github/grommet/grommet/badge.svg?branch=master)](https://coveralls.io/github/grommet/grommet?branch=master) [![Code Climate](https://codeclimate.com/github/grommet/grommet/badges/gpa.svg)](https://codeclimate.com/github/grommet/grommet) [![Dependency Status](https://david-dm.org/grommet/grommet.svg)](https://david-dm.org/grommet/grommet) [![devDependency Status](https://david-dm.org/grommet/grommet/dev-status.svg)](https://david-dm.org/grommet/grommet#info=devDependencies) [![CDNJS](https://img.shields.io/cdnjs/v/grommet.svg)](https://cdnjs.com/libraries/grommet)
|
4 |
|
5 | <img align="right" height="260" src="https://grommet.github.io/img/grommet.svg">
|
6 |
|
7 | ### Documentation
|
8 |
|
9 | Visit the [grommet.github.io](https://grommet.github.io/) website for more information.
|
10 |
|
11 | ### Support / Contributing
|
12 |
|
13 | Before opening an issue or pull request, please read the [Contributing](https://github.com/grommet/grommet/blob/master/CONTRIBUTING.md) guide.
|
14 |
|
15 | ### Hello World
|
16 |
|
17 | The quickest way to get started is to access the [Hello World](https://grommet.github.io/docs/hello-world) page.
|
18 |
|
19 | ### Install
|
20 |
|
21 | You can install Grommet using either of the methods below.
|
22 |
|
23 | For Bower users:
|
24 | ```
|
25 | $ bower install grommet
|
26 | ```
|
27 |
|
28 | For NPM users:
|
29 | ```
|
30 | $ npm install -g grommet
|
31 | ```
|
32 |
|
33 | Detailed instructions are on the [Get Started](https://grommet.github.io/docs/get-started) page.
|
34 |
|
35 | ### Build
|
36 |
|
37 | Refer to the [Grommet Build Wiki](https://github.com/grommet/grommet/wiki/Building-Grommet) for instructions on how to install your local copy of Grommet.
|
38 |
|
39 | ### Release History
|
40 |
|
41 | See the [Change Log](https://github.com/grommet/grommet/wiki/Change-Log).
|
42 |
|
43 | ### Tools Behind Grommet
|
44 |
|
45 | Grommet is produced using these great tools
|
46 | * [Travis CI](https://travis-ci.org/grommet/grommet) for continuous integration
|
47 | * [Sauce Labs](https://saucelabs.com/) for automated browser testing
|
48 | * [BrowserStack](https://www.browserstack.com) for manual browser testing
|
49 | * [Waffle.io](https://waffle.io/grommet/grommet) for backlog tracking
|
50 |
|
\ | No newline at end of file |