jervis-form 0.0.0-alpha.0 → 0.0.0-alpha.2

package/README.md

@@ -24,6 +24,61 @@ Make sure these are installed in your app:
 npm run build
 ```
 
+## Documentation (VitePress)
+
+Run docs locally:
+
+```bash
+npm run docs:dev
+```
+
+Build docs for static hosting:
+
+```bash
+npm run docs:build
+npm run docs:preview
+```
+
+## Custom Input Registration
+
+Register custom field components globally with the plugin:
+
+```js
+import { createApp } from "vue";
+import App from "./App.vue";
+import { JervisFormPlugin } from "jervis-form";
+import MyCustomInput from "./components/MyCustomInput.vue";
+
+const app = createApp(App);
+
+app.use(JervisFormPlugin, {
+  customFieldTypes: {
+    myCustomInput: MyCustomInput,
+  },
+});
+```
+
+Then use it in your schema:
+
+```js
+const schema = [
+  {
+    type: "myCustomInput",
+    key: "customValue",
+    label: "Custom Value",
+  },
+];
+```
+
+You can also register custom fields locally on a single GenericForm instance:
+
+```vue
+<GenericForm
+  :schema="schema"
+  :customFieldTypes="{ myCustomInput: MyCustomInput }"
+/>
+```
+
 ## Publish Checklist
 
 ```bash