Skip to content

Commit 1bc83a0

Browse files
authored
Merge pull request #162 from cristijora/imporve-readme
Readme improvements
2 parents 934146c + 846cf15 commit 1bc83a0

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

+21-9
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,27 @@ A schema-based form generator component for Vue.js.
1717
[![Screenshot](https://icebob.gitbooks.io/vueformgenerator/content/assets/vfg-example1.png)](https://jsfiddle.net/icebob/0mg1v81e/)
1818

1919
## Features
20-
- multiple objects editing
21-
- core & full bundles
20+
- reactive forms based on schemas
21+
- multiple object editing
2222
- 21 field types
2323
- built-in validators
24+
- core & full bundles (11kb and 19kb gzipped)
2425
- Bootstrap friendly templates
2526
- customizable styles
26-
- extendable with custom fields
27+
- can be extended easily with custom fields
2728
- ...etc
2829

2930
## Documentation
3031
[Online documentation on Gitbook](https://icebob.gitbooks.io/vueformgenerator/content/)
3132

3233
## Dependencies
33-
vue-form-generator use [fecha](https://github.com/taylorhakes/fecha) and [lodash](https://lodash.com/) internally.
34+
vue-form-generator uses [fecha](https://github.com/taylorhakes/fecha) and [lodash](https://lodash.com/) internally.
3435

3536
While built-in fields don't need external dependencies, optional fields may need other libraries.
36-
These dependency fall in two camp: jQuery or Vanilla. You can find almost the same functionality in both flavor.
37-
That way, it's your choice to depend on jQuery or not.
37+
These dependencies fall into two camps: jQuery or Vanilla. You can find almost the same functionality in both flavors.
38+
In the end, it's your choice to depend on jQuery or not.
3839

39-
You can find details about dependencies in [documentation](https://icebob.gitbooks.io/vueformgenerator/content/).
40+
You can find details about dependencies in the official [documentation](https://icebob.gitbooks.io/vueformgenerator/content/) under each specific component.
4041

4142
## Installation
4243
### NPM
@@ -156,6 +157,17 @@ export default {
156157
</script>
157158
```
158159

160+
Usage in local components
161+
```
162+
import VueFormGenerator from "vue-form-generator";
163+
164+
//component javascript
165+
export default{
166+
components:{
167+
"vue-form-generator": VueFormGenerator.component
168+
}
169+
}
170+
```
159171
## Development
160172
This command will start a `webpack-dev-server` with content of `dev` folder.
161173
```bash
@@ -178,7 +190,7 @@ npm run ci
178190
```
179191

180192
## More fields *new*
181-
VueFormGenerator support custom fields. If you decide to release your custom field into the wild, please open a new issue so we can add you to a list here! Please try to use this naming convention for your custom field : vfg-field-* Example :
193+
VueFormGenerator supports custom fields. If you decide to release your custom field into the wild, please open a new issue so we can add you to a list here! Please try to use this naming convention for your custom field : vfg-field-* Example :
182194

183195
- `vfg-field-myfield`
184196
- `vfg-field-calendar`
@@ -196,4 +208,4 @@ vue-form-generator is available under the [MIT license](https://tldrlegal.com/li
196208

197209
Copyright (C) 2017 Icebob
198210

199-
[![@icebob](https://img.shields.io/badge/github-icebob-green.svg)](https://github.com/icebob) [![@icebob](https://img.shields.io/badge/twitter-Icebobcsi-blue.svg)](https://twitter.com/Icebobcsi)
211+
[![@icebob](https://img.shields.io/badge/github-icebob-green.svg)](https://github.com/icebob) [![@icebob](https://img.shields.io/badge/twitter-Icebobcsi-blue.svg)](https://twitter.com/Icebobcsi)

0 commit comments

Comments
 (0)