# cmx-components

[![Travis][build-badge]][build]
[![npm package][npm-badge]][npm]
[![Coveralls][coveralls-badge]][coveralls]

Describe cmx-components here.

[build-badge]: https://img.shields.io/travis/user/repo/master.png?style=flat-square
[build]: https://travis-ci.org/user/repo

[npm-badge]: https://img.shields.io/npm/v/npm-package.png?style=flat-square
[npm]: https://www.npmjs.org/package/npm-package

[coveralls-badge]: https://img.shields.io/coveralls/user/repo/master.png?style=flat-square
[coveralls]: https://coveralls.io/github/user/repo

# CMX React Components NPM package

# Installation

cmx-components is available as an [npm package](https://www.npmjs.org/package/cmx-components).

```
npm install cmx-components --save
```

# Run demos locally and contribute
```
git clone git@github.com:Celmatix/react-components.git

npm install

npm start
```

Add new components in the src folder

Import component in src/index.js and add to named exports at bottom

Add a demo folder for component in demo/component-demos

Import demo into demo/index file

# To build and publish
```
npm run build

(Increment version number in  package.json. Also, will need to be added as npm owner on package. Contact Katherine Martinez to be added)

npm publish
```

# Usage

```
import {TextInput, Button} from 'cmx-components'
```

# Roadmap

Add tests