# Grommet: focus on the essential experience

[![PRs Welcome](https://img.shields.io/badge/pr's-welcome-7d4cdb.svg)](https://github.com/grommet/grommet/blob/master/CONTRIBUTING.md)
[![slack](https://img.shields.io/badge/join%20the%20community-slack-fd6fff.svg)](http://slackin.grommet.io)
[![follow](https://img.shields.io/twitter/follow/grommet_io.svg?label=follow%20&style=social)](https://twitter.com/grommet_io)
[![blogs](https://img.shields.io/badge/view%20blogs%20on-medium-000000.svg)](https://medium.com/grommet-io)
[![npm package](https://img.shields.io/npm/v/grommet.svg?color=ffca58)](https://www.npmjs.com/package/grommet)
[![npm downloads](https://img.shields.io/npm/dm/grommet.svg?color=3d138d)](https://www.npmjs.com/package/grommet)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

<img align="right" height="260" src="https://v2.grommet.io/img/stak-hurrah.svg">

### Documentation

Visit the [Grommet v2](https://v2.grommet.io/) website for more information.

### Support / Contributing

Before opening an issue or pull request, please read the [Contributing](https://github.com/grommet/grommet/blob/master/CONTRIBUTING.md) guide.

### Install

You can install Grommet using either of the methods below.

For NPM users:

```
  $ npm install grommet styled-components --save
```

Detailed instructions are on the [Get Started](https://v2.grommet.io/use) page.

### Explore

1. [Storybook](https://storybook.grommet.io) examples per component, you can see them by running:
```
  $ npm run storybook
```

2. Basic [code-sandbox playgrounds](https://codesandbox.io/s/github/grommet/grommet-sandbox) for each component

3. [Templates, patterns and starters](https://codesandbox.io/u/grommetux/sandboxes) feel free to share with us more pattern ideas on [slack](http://slackin.grommet.io)

4. End-2-End project examples from our community on [#i-made-this](http://slackin.grommet.io) channel

5. Read more from the Grommet team on [Medium](https://medium.com/grommet-io)

### Release History

See the [Change Log](https://github.com/grommet/grommet/wiki/Change-Log).

### Tools Behind Grommet

Grommet is produced using this great tool

- [Circle CI](https://circleci.com/gh/grommet/grommet/) for continuous integration
