Skip to content

Commit

Permalink
npm published
Browse files Browse the repository at this point in the history
  • Loading branch information
rickyleung committed Aug 17, 2015
1 parent 0626843 commit fd140ec
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 17 deletions.
43 changes: 26 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
#BizUI Framework
BizUI Framework
===============

[![Code Climate](https://codeclimate.com/github/bizdevfe/biz-ui/badges/gpa.svg)](https://codeclimate.com/github/bizdevfe/biz-ui)
[![Build Status](https://travis-ci.org/bizdevfe/biz-ui.svg?branch=master)](https://travis-ci.org/bizdevfe/biz-ui)

BizUI is a jQuery plugin for business UI components, have a [quick view](http://bizdevfe.github.io/biz-ui/quickview/):
BizUI is a jQuery plugin for business UI components. Have a [quick view](http://bizdevfe.github.io/biz-ui/quickview/):

<img src="http://bizdevfe.github.io/biz-ui/img/demo.png" />

##Features
* Include 14 types of UI components: Button, Input, Textarea, Radio, Checkbox, Select, Dialog, Panel, Tooltip, Tab, Page, Tree, Calendar, Table.
* IE9+, Firefox, Chrome, Safari and Opera supported.
* Import other awesome components with the constant API using Adapter Pattern.
Features
--------
- Include 14 types of UI components: Button, Input, Textarea, Radio, Checkbox, Select, Dialog, Panel, Tooltip, Tab, Page, Tree, Calendar, Table.
- IE9+, Firefox, Chrome, Safari and Opera supported.
- Import other awesome components with the constant API using Adapter Pattern.

<img src="http://bizdevfe.github.io/biz-ui/img/adapter.png" />

##Usage
Download the latest version: [https://github.com/bizdevfe/biz-ui/releases](https://github.com/bizdevfe/biz-ui/releases).
Usage
-----
Download the latest version: [https://github.com/bizdevfe/biz-ui/releases](https://github.com/bizdevfe/biz-ui/releases), or:

npm install biz-ui

Together with jQuery, include BizUI in your page:

Expand All @@ -35,24 +40,28 @@ You can also load BizUI as a AMD module:
To initialize:

// recommended
$('button').bizButton();
// or create instance by constructor
var button = new bizui.Button($('button'));
$('button').bizButton();
// or create instance by constructor
var button = new bizui.Button($('button'));

Customize themes: Theme styles are extracted to [theme-custom.less](https://github.com/bizdevfe/biz-ui/blob/master/src/css/theme-custom.less), to customize themes of your own, just simply mofidy the following colors: @primary-color, @assistant-color and @text-color.

##API documentation and demos
API documentation and demos
---------------------------
See [http://bizdevfe.github.io/biz-ui](http://bizdevfe.github.io/biz-ui).

##Build
Build
-----
Do the code inspection, optimization or API generation here:

$ cd tool
$ build.sh

##License
License
-------
Licensed under the [MIT license](http://opensource.org/licenses/MIT).

##Feedback
For issues or suggestions please see [biz-ui](https://github.com/bizdevfe/biz-ui) on Github. Thanks for your support!
Feedback
--------
For issues or suggestions please see [biz-ui](https://github.com/bizdevfe/biz-ui) on Github. Thanks for your support!
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
"devDependencies": {
"jshint": "2.8.x",
"js-beautify": "1.5.x",
"lessc": "2.5.x",
"almond": "0.2.x",
"requirejs": "2.1.x"
}
Expand Down

0 comments on commit fd140ec

Please sign in to comment.