<commit_before>[![Build Status](https://travis-ci.org/rackerlabs/canon-react.svg)](https://travis-ci.org/rackerlabs/canon-react)

CAUTION: This library is not ready for public use yet.

# canon-react
React components for Rackspace's Canon framework

## Instructions For Devs
Git clone and run `npm install` to install dependencies (may need to be run as sudo)

### Building
To build a bundled file for release run `npm run build`
To build a demo bundle for testing run `npm run demo-build` and open `canon-react/demo/index.html` in your browser

### Testing
To run tests with phantom run `npm run test`
To run tests in chrome and watch for changes run `npm run test-watch`

## Instructions For Including In Your Project
`npm install canon-react` will install the canon-react module inside of the `node_modules` directory of your current directory. `npm install canon-react -g` (may need sudo) will install the canon-react module globally.

### Using Components
Access canon react components via `var component = require('canon-react').component;` after installation. An example of how to use canon-react components can be found in `node_modules/canon-react/demo/demo.jsx`

# Roadmap
This is a list of what is planned for the next release
## v 0.2.0
1. Action Button
2. Action Dropdown
3. Popovers
4. Status Indicator
5. Tooltips
6. NPM Module<commit_msg>update readme with es6 import example<commit_after>[![Build Status](https://travis-ci.org/rackerlabs/canon-react.svg)](https://travis-ci.org/rackerlabs/canon-react)

CAUTION: This library is not ready for public use yet.

# canon-react
React components for Rackspace's Canon framework

## Instructions For Devs
Git clone and run `npm install` to install dependencies (may need to be run as sudo)

### Building
To build a bundled file for release run `npm run build`
To build a demo bundle for testing run `npm run demo-build` and open `canon-react/demo/index.html` in your browser

### Testing
To run tests with phantom run `npm run test`
To run tests in chrome and watch for changes run `npm run test-watch`

## Instructions For Including In Your Project
`npm install canon-react` will install the canon-react module inside of the `node_modules` directory of your current directory. `npm install canon-react -g` (may need sudo) will install the canon-react module globally.

### Using Components
After installation you can use canon react components.

```javascript
var Component = require('canon-react').Component;
```

ES6:

```javascript
import {Component} from 'canon-react';
```

An example of how to use canon-react components can be found in `node_modules/canon-react/demo/demo.jsx`

# Roadmap
This is a list of what is planned for the next release
## v 0.2.0
1. Action Button
2. Action Dropdown
3. Popovers
4. Status Indicator
5. Tooltips
6. NPM Module
{'fraction_non_alphanumeric': 0.08561278863232683, 'fraction_numerical': 0.007104795737122558, 'mean_word_length': 4.510763209393346, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3882786', 'n_tokens_mistral': 849, 'n_tokens_neox': 804, 'n_words': 376}