Skip to content

Commit 90403bb

Browse files
committed
Update README.md
1 parent 07bcdae commit 90403bb

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

README.md

+25-6
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,39 @@
1-
# vue-form-generator
1+
# vue-form-generator [![NPM version](https://img.shields.io/npm/v/vue-form-generator.svg)](https://www.npmjs.com/package/vue-form-generator)
22
A schema-based form generator component for Vue.js
33

4+
[![Downloads](https://img.shields.io/npm/dt/vue-form-generator.svg)](https://www.npmjs.com/package/vue-form-generator)
5+
46
## Demo
57
[JSFiddle simple example](https://jsfiddle.net/icebob/0mg1v81e/)
68

79
## Features
8-
TODO
10+
- multiple objects editing
11+
- 18 built-in field types
12+
- built-in validations
13+
- Bootstrap friendly templates
14+
- ...etc
915

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

1326
## Installation
1427
### NPM
15-
TODO
16-
28+
Installation uses the [npm](http://npmjs.org/) package manager. Just type the following command after installing npm.
29+
```
30+
$ npm install vue-form-generator
31+
```
1732
### Manual
18-
TODO
33+
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.
34+
```
35+
https://github.com/icebob/vue-form-generator/archive/master.zip
36+
```
1937

2038
## Usage
2139
TODO
@@ -45,6 +63,7 @@ TODO
4563
* [ ] Groupable fields
4664
* [ ] Validation handling with multiple models
4765
* [ ] Bundle for vendor files
66+
* [ ] Unit tests, coverage and CI
4867

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

0 commit comments

Comments
 (0)