# nek-ui <sup>[WIP]</sup>
UI components based on [RegularJS][regularjs]

[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url]

[=> Documents <=](https://kaola-fed.github.io)

[=> CodePen <=](http://codepen.io/int64ago/pen/WRmzPV)

### Usage

 - For browser:
 ```
 //unpkg.com/nek-ui/dist/css/nek-ui.default.min.css
 //unpkg.com/nek-ui/dist/vendor/regular.min.js
 //unpkg.com/nek-ui/dist/js/nek-ui.min.js
 ```

 - For Node:
 ```
 npm i regularjs@0.4.3 nek-ui -S

 const NEKUI = require('nek-ui');

 ```

### Development

 - `cd doc && npm i`
 - `cd .. && npm i`
 - `npm run dev`

 :memo: For more in [WIKI](https://github.com/kaola-fed/nek-ui/wiki)

### Reference

 - [Regular UI](https://regular-ui.github.io/) - forked from
 - [Vue](https://cn.vuejs.org/) - docs style
 - [Ant Design](https://ant.design/) - ideas
 - [Element](http://element.eleme.io) - ideas

### LICENSE
MIT


 [regularjs]: https://github.com/regularjs/regular

 [npm-url]: https://npmjs.org/package/nek-ui
 [npm-image]: https://img.shields.io/npm/v/nek-ui.svg

 [travis-url]: https://travis-ci.org/kaola-fed/nek-ui
 [travis-image]: https://img.shields.io/travis/kaola-fed/nek-ui.svg

 [license-url]: https://github.com/kaola-fed/nek-ui/blob/master/LICENSE
 [license-image]: https://img.shields.io/github/license/kaola-fed/nek-ui.svg