diff --git a/README.md b/README.md index b8675248..67497066 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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).