regular-hotzone/README.md

Hot Zone of Regular Components

# regular-hotzone

[![version](https://img.shields.io/npm/v/regular-hotzone.svg)](https://www.npmjs.com/package/regular-hotzone)
[![Build Status](https://img.shields.io/travis/Deol/regular-hotzone.svg)](https://travis-ci.org/Deol/regular-hotzone)
[![Github licences](https://img.shields.io/github/license/Deol/regular-hotzone.svg)](https://github.com/Deol/regular-hotzone/blob/master/LICENSE)

[![nodei](https://nodei.co/npm/regular-hotzone.png?downloads=true)](https://www.npmjs.com/package/regular-hotzone)

A HotZone Component based on [RegularJS](https://github.com/regularjs/regular).

## DEMO
[http://aeodu.com/regular-hotzone](http://aeodu.com/regular-hotzone)

## Installation

```bash
$ npm install regularjs regular-hotzone

# only if hotzone.config.showCopy === true
$ npm install clipboard
```

## Usage

 - CommonJS

```
var hotZone = require('regular-hotzone');
```

 - Global

Include the link and the script in the browser:

```html
<!-- css -->
<link rel="stylesheet" href="//unpkg.com/regular-hotzone/dist/hotzone.min.css">

<!-- RegularJS -->
<script src="https://rawgit.com/regularjs/regular/master/dist/regular.js"></script>
<!-- the hotZone component -->
<script src="//unpkg.com/regular-hotzone/dist/hotzone.min.js"></script>
```

## CDN

[**unpkg**](https://unpkg.com)

```sh
# css
//unpkg.com/regular-hotzone/dist/hotzone.min.css

# js
//unpkg.com/regular-hotzone/dist/hotzone.min.js
```

## Development

``` bash
# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run startdev

# build for production with minification
npm run build
```

## LICENSE

MIT