Merge branch 'main' into 8-tests

# Conflicts:
#	yarn.lock

Author: kevinkosterr

README.md

@@ -1,89 +1,26 @@
 # Vue 3 Form Generator
-A schema-based form generator component for Vue 3, based on `vue-form-generator`
+![GitHub last commit](https://img.shields.io/github/last-commit/kevinkosterr/vue3-form-generator?logo=github)
+![Static Badge](https://img.shields.io/badge/Vue%20version-3.x.x-green?logo=vue.js)
+![NPM Version](https://img.shields.io/npm/v/%40kevinkosterr%2Fvue3-form-generator?logo=npm)
+![GitHub License](https://img.shields.io/github/license/kevinkosterr/vue3-form-generator)
+<br>
+A schema-based form generator component for Vue 3, based on the original 
+[`vue-form-generator`](https://github.com/vue-generators/vue-form-generator) library.
 
-## Basic usage
-1. Install plugin in your Vue app, this will make all necessary components globally available in your app.
-```javascript
-// ...
+You can find documentation on the [documentation page](https://kevinkosterr.github.io/vue3-form-generator-docs).
 
-import VueFormGenerator from '@kevinkosterr/vue3-form-generator'
-
-app.use(VueFormGenerator)
-
-// ...
+## Building for development
+1. Install the dependencies
+```bash
+yarn install
 ```
-2. Define a schema inside your Vue component
-<br><br>
-#### Composition API:
-```vue
-<template>
-  <vue-form-generator :schema="form.schema" :model="form.model"/>
-</template>
-
-<script setup>
-  import { ref } from 'vue'
-  
-  const form = ref({
-    model: {
-      name: '',
-      terms: false,
-    },
-    schema: {
-      fields: [
-        {
-          name: 'name',
-          label: 'Name',
-          type: 'input',
-          inputType: 'text',
-          model: 'name',
-          placeholder: "Write name...",
-          readonly: false,
-          required: true,
-        },
-        {
-          name: 'terms',
-          label: 'Accept terms and conditions',
-          type: 'input',
-          inputType: 'checkbox',
-          model: 'terms',
-        }
-      ]
-    }
-  })
-</script>
+2. Create a schema inside the playground folder, for this you can copy `schema.example.js`.
+```bash
+cp playground/schema.example.js playground/schema.js
 ```
-#### Options API:
-```vue
-<template>
-  <vue-form-generator :schema="form.schema" :model="form.model"/>
-</template>
-
-<script>
-  export default {
-    data () {
-      return {
-        form: {
-          model: {
-            name: '',
-          },
-          schema: {
-            fields: [
-              {
-                name: 'name',
-                label: 'Name',
-                type: 'input',
-                inputType: 'text',
-                model: 'name',
-                placeholder: "Write name...",
-                readonly: false,
-                required: true,
-              }
-            ]
-          }
-        }
-      }
-    }
-  }
-</script>
+3. Run the development playground
+```bash
+yarn run dev 
 ```
 
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kevinkosterr/vue3-form-generator",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "private": false,
   "type": "module",
   "author": "Kevin Koster (@kevinkoster)",
@@ -24,6 +24,15 @@
   "files": [
     "dist"
   ],
+  "keywords": [
+    "vue-form-generator",
+    "form generator",
+    "form",
+    "schema",
+    "vue3-form-generator",
+    "vue3 forms",
+    "vuejs"
+  ],
   "dependencies": {},
   "devDependencies": {
     "@stylistic/eslint-plugin": "^2.8.0",