Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
icebob committed May 3, 2016
1 parent 07bcdae commit 90403bb
Showing 1 changed file with 25 additions and 6 deletions.
31 changes: 25 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,39 @@
# vue-form-generator
# vue-form-generator [![NPM version](https://img.shields.io/npm/v/vue-form-generator.svg)](https://www.npmjs.com/package/vue-form-generator)
A schema-based form generator component for Vue.js

[![Downloads](https://img.shields.io/npm/dt/vue-form-generator.svg)](https://www.npmjs.com/package/vue-form-generator)

## Demo
[JSFiddle simple example](https://jsfiddle.net/icebob/0mg1v81e/)

## Features
TODO
- multiple objects editing
- 18 built-in field types
- built-in validations
- Bootstrap friendly templates
- ...etc

## Dependencies
TODO
- [jQuery](http://www.jquery.com)
- [Moment.js](http://momentjs.com/) (built-in)
- [lodash](https://lodash.com/) (built-in)
- [BootStrap](http://getbootstrap.com/) (optional)
- [bootstrap-select](https://silviomoreto.github.io/bootstrap-select/) for `selectEx` fields (optional)
- [bootstrap-datetimepicker](https://github.com/Eonasdan/bootstrap-datetimepicker) for `datetime` fields (optional)
- [spectrum](https://github.com/bgrins/spectrum) for `spectrum` color picker fields (optional)
- [maskedinput](http://digitalbush.com/projects/masked-input-plugin/) for `masked` fields

## Installation
### NPM
TODO

Installation uses the [npm](http://npmjs.org/) package manager. Just type the following command after installing npm.
```
$ npm install vue-form-generator
```
### Manual
TODO
Download zip package and unpack and add the `vue-form-generator.js` or `vue-form-generator.min.js` file to your project from dist folder.
```
https://github.com/icebob/vue-form-generator/archive/master.zip
```

## Usage
TODO
Expand Down Expand Up @@ -45,6 +63,7 @@ TODO
* [ ] Groupable fields
* [ ] Validation handling with multiple models
* [ ] Bundle for vendor files
* [ ] Unit tests, coverage and CI

## License
vue-form-generator is available under the [MIT license](https://tldrlegal.com/license/mit-license).
Expand Down

0 comments on commit 90403bb

Please sign in to comment.