# whiplash-ui-library

[![Travis][build-badge]][build]
[![npm package][npm-badge]][npm]
[![CodeCov][codecov-badge]][codecov]

Official React component UI library for [Whiplash Merch](https://www.whiplashmerch.com/).

[build-badge]: https://travis-ci.com/whiplashmerch/whiplash-ui-library.svg?token=7sqecPgxJNHKkKxQk6v2&branch=master
[build]: https://travis-ci.org/whiplashmerch/whiplash-ui-library

[npm-badge]: https://img.shields.io/npm/v/whiplash-ui-library.svg
[npm]: https://www.npmjs.com/package/whiplash-ui-library

[codecov-badge]: https://codecov.io/gh/whiplashmerch/whiplash-ui-library/branch/master/graph/badge.svg
[codecov]: https://codecov.io/gh/whiplashmerch/whiplash-ui-library

### Installation
with NPM:
```
npm i whiplash-ui-library --save
```

with Yarn:
```
yarn add whiplash-ui-library
```


### Usage
Using Components:
```
import { Button } from 'whiplash-ui-library';
```

Live Example of all Available components:
[Whiplash UI Library Example](https://whiplashmerch.github.io/whiplash-ui-library/)

Updates:
[Whiplash UI Library Change log](https://github.com/whiplashmerch/whiplash-ui-library/blob/master/CHANGELOG.md)

### We use rem units
To ensure the UI kit display's properly in your UI, be sure to add a
default `font-size` of 16px to your app. It's pretty common and a good practice
to do. At the most global point, add this to your CSS if you don't already
have it:

```
* {
  font-size: 16px;
}
```

<br />
*More Components Coming Soon!*