yourcomponent

COMPONENT DESCRIPTION GOES HERE

Demo & Examples

Live demo: .github.io/yourcomponent

To build the package locally, run:

$ npm install

To run the package demo locally, run the demo-app :

$ npm install
$ clap dev

Then open localhost:8000 in a browser.

Installation

The easiest way to use yourcomponent is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

You can also use the standalone build by including dist/yourcomponent.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

$ npm install yourcomponent --save

Usage

EXPLAIN USAGE HERE

var YourComponent = require('yourcomponent');

<YourComponent>Example</YourComponent>

Properties

• DOCUMENT PROPERTIES HERE

Notes

ADDITIONAL USAGE NOTES

Development (src, lib and the build process)

NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.

License

PUT LICENSE HERE

Copyright (c) 2017 .