diff --git a/README.md b/README.md index f079268d..57df83d3 100644 --- a/README.md +++ b/README.md @@ -18,17 +18,19 @@ A schema-based form generator component for Vue.js. ## Features - multiple objects editing -- 27 field types +- core & full bundles +- 21 field types - built-in validators - Bootstrap friendly templates - customizable styles +- extendable with custom fields - ...etc ## Documentation [Online documentation on Gitbook](https://icebob.gitbooks.io/vueformgenerator/content/) ## Dependencies -vue-form-generator use [Moment.js](http://momentjs.com/) and [lodash](https://lodash.com/) internally. +vue-form-generator use [fecha](https://github.com/taylorhakes/fecha) and [lodash](https://lodash.com/) internally. While built-in fields don't need external dependencies, optional fields may need other libraries. These dependency fall in two camp: jQuery or Vanilla. You can find almost the same functionality in both flavor. @@ -51,11 +53,31 @@ $ npm install vue-form-generator@0.6.1 ``` ### Manual -Download zip package and unpack and add the `vue-form-generator.css` and `vue-form-generator.js` file to your project from dist folder. +Download zip package and unpack and add the vfg.css and vfg.js file to your project from dist folder. ``` https://github.com/icebob/vue-form-generator/archive/master.zip ``` +### Core vs Full version + +VueFormGenerator come in two version : `core` and `full`. +Core is a more minimal version with only half the fields. +Full is core + other fields. + +* Full bundle: 75 kB (gzipped: 19 kB) +* Core bundle: 39 kB (gzipped: 11 kB) + +If you don't know what to choose, don't worry, the full is the default version. +If you want the slim down version, here is the changes: + +```js +// the "core" way + +``` + ## Usage ```html