# BlaBlaCar React component library
[![Build Status](https://travis-ci.org/blablacar/ui-library.svg?branch=master)](https://travis-ci.org/blablacar/ui-library)
[![npm version](https://img.shields.io/npm/v/@blablacar/ui-library.svg)](https://www.npmjs.com/package/@blablacar/ui-library)

## Installation
BlaBlaCar `ui-library` is available as an [npm package](https://www.npmjs.com/package/@blablacar/ui-library)

Just run this inside your project
```bash
npm i @blablacar/ui-library
```

## Usage
Import the package into your `package.json`. You will also need the following peer dependencies:
```
"dependencies": {
    ...
    "@blablacar/ui-library": "<CURRENT_VERSION>",
    "react": "<CURRENT_VERSION>",
    "react-dom": "<CURRENT_VERSION>",
    "styled-components": "<CURRENT_VERSION>",
    "classcat": "<CURRENT_VERSION>",
    ...
}
```
then all you need to do is:
```javascript
import { Button } from '@blablacar/ui-library/build/button'
```
But again, don't forget that you need to have React to make it work.


## Changelog
Check the [changelog](https://github.com/blablacar/ui-library/blob/master/CHANGELOG.md) to stay informed on all updates

## Examples and documentation
You can find examples and tech documentation [here](https://blablacar.github.io/ui-library/).

## Contributing
Wanna contribute ? [This way.](https://github.com/blablacar/ui-library/blob/master/CONTRIBUTING.md) :)

## License
This project is licensed under the terms of the [MIT license](https://github.com/blablacar/ui-library/blob/master/LICENSE).