diff --git a/README.md b/README.md index 5a8b865..cbdcc47 100644 --- a/README.md +++ b/README.md @@ -1,89 +1,21 @@ # Vue 3 Form Generator -A schema-based form generator component for Vue 3, based on `vue-form-generator` +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 -

-#### Composition API: -```vue - - - +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 - - - +3. Run the development playground +```bash +yarn run dev ``` +