From e7fbc2256504ac59b9de6991b26bf90707425212 Mon Sep 17 00:00:00 2001
From: Thanga Ganapathy <ganapathy888@gmail.com>
Date: Fri, 15 Mar 2024 04:26:29 +0530
Subject: [PATCH] docs: updte readme

---
 .changeset/cuddly-dodos-greet.md   |  5 +++++
 README.md                          | 36 +++++-------------------------
 apps/website/docs/intro.md         | 12 +++++-----
 packages/react-form/README.md      | 36 +++++-------------------------
 packages/react-form/package.json   |  6 +++--
 packages/react-form/tsup.config.js |  2 +-
 6 files changed, 28 insertions(+), 69 deletions(-)
 create mode 100644 .changeset/cuddly-dodos-greet.md

diff --git a/.changeset/cuddly-dodos-greet.md b/.changeset/cuddly-dodos-greet.md
new file mode 100644
index 0000000..bdfc035
--- /dev/null
+++ b/.changeset/cuddly-dodos-greet.md
@@ -0,0 +1,5 @@
+---
+'@opentf/react-form': minor
+---
+
+Updated docs
diff --git a/README.md b/README.md
index 4a2ab0d..6ad2083 100644
--- a/README.md
+++ b/README.md
@@ -10,17 +10,17 @@
 
 </div>
 
-> A simple form state management for React.
+> A simple form state manager for React.
 
-# [View Demo](https://react-form.pages.dev/#demo) | [Documentation](https://react-form.pages.dev/) 
+# [Live Demo](https://react-form.pages.dev/#demo) | [Documentation](https://react-form.pages.dev/)
 
 ## Features
 
 - Simple APIs to use
 
-- It supports nested & array fields
+- Supports nested & array fields
 
-- It supports form validation
+- Supports form validation (Works with any schema validation lib)
 
 - Render optimized
 
@@ -52,37 +52,13 @@ import { Form, Field } from '@opentf/react-form';
 export default function App() {
   return (
     <Form
+      initialValues={{ field1: '', field2: '' }}
       onSubmit={(values) => {
         console.log(values);
       }}
     >
       <Field name="field1" />
-      <button type="submit">Submit</button>
-    </Form>
-  );
-}
-```
-
-## Usage (TypeScript)
-
-```tsx
-import { Form, Field } from '@opentf/react-form';
-
-interface FormValues {
-  field1: string;
-}
-
-export default function App() {
-  const initialValues: FormValues = { field1: '' };
-
-  return (
-    <Form
-      initialValues={initialValues}
-      onSubmit={(values) => {
-        console.log(values);
-      }}
-    >
-      <Field name="field1" />
+      <Field name="field2" type="number" />
       <button type="submit">Submit</button>
     </Form>
   );
diff --git a/apps/website/docs/intro.md b/apps/website/docs/intro.md
index 1044013..96a3108 100644
--- a/apps/website/docs/intro.md
+++ b/apps/website/docs/intro.md
@@ -13,20 +13,20 @@ import MUI from '!!raw-loader!@site/src/Demo/MUI';
 
 # React Form
 
-> A simple form state management for React.
+> A simple form state manager for React.
 
 ## Features
 
-- Simple API
+- Simple APIs to use
 
-- It supports nested & array fields
+- Supports nested & array fields
 
-- It supports form validation
-
-- TypeScript support
+- Supports form validation (Works with any schema validation lib)
 
 - Render optimized
 
+- TypeScript support
+
 - <a href="https://bundlephobia.com/package/@opentf/react-form">Minified + GZip Size ~3KB</a>
 
 ## DEMO
diff --git a/packages/react-form/README.md b/packages/react-form/README.md
index 5b4e2de..8a4b6e9 100644
--- a/packages/react-form/README.md
+++ b/packages/react-form/README.md
@@ -10,17 +10,17 @@
 
 </div>
 
-> A simple form state management for React.
+> A simple form state manager for React.
 
-# [View Demo](https://react-form.pages.dev/#demo) | [Documentation](https://react-form.pages.dev/) 
+# [Live Demo](https://react-form.pages.dev/#demo) | [Documentation](https://react-form.pages.dev/)
 
 ## Features
 
 - Simple APIs to use
 
-- It supports nested & array fields
+- Supports nested & array fields
 
-- It supports form validation
+- Supports form validation (Works with any schema validation lib)
 
 - Render optimized
 
@@ -52,37 +52,13 @@ import { Form, Field } from '@opentf/react-form';
 export default function App() {
   return (
     <Form
+      initialValues={{ field1: '', field2: '' }}
       onSubmit={(values) => {
         console.log(values);
       }}
     >
       <Field name="field1" />
-      <button type="submit">Submit</button>
-    </Form>
-  );
-}
-```
-
-## Usage (TypeScript)
-
-```tsx
-import { Form, Field } from '@opentf/react-form';
-
-interface FormValues {
-  field1: string;
-}
-
-export default function App() {
-  const initialValues: FormValues = { field1: '' };
-
-  return (
-    <Form
-      initialValues={initialValues}
-      onSubmit={(values) => {
-        console.log(values);
-      }}
-    >
-      <Field name="field1" />
+      <Field name="field2" type="number" />
       <button type="submit">Submit</button>
     </Form>
   );
diff --git a/packages/react-form/package.json b/packages/react-form/package.json
index c65b7c3..63780ab 100644
--- a/packages/react-form/package.json
+++ b/packages/react-form/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@opentf/react-form",
   "version": "0.21.1",
-  "description": "A simple form state management for React.",
+  "description": "A simple form state manager for React.",
   "homepage": "https://react-form.pages.dev/",
   "keywords": [
     "react",
@@ -13,7 +13,9 @@
     "zod",
     "material-ui",
     "mui",
-    "chakra-ui"
+    "chakra-ui",
+    "schema",
+    "json"
   ],
   "type": "module",
   "main": "dist/index.cjs",
diff --git a/packages/react-form/tsup.config.js b/packages/react-form/tsup.config.js
index 849c499..fa4e822 100644
--- a/packages/react-form/tsup.config.js
+++ b/packages/react-form/tsup.config.js
@@ -8,5 +8,5 @@ export default defineConfig({
   format: ['cjs', 'esm'],
   dts: true,
   minify: true,
-  name: 'utils',
+  name: 'reactForm',
 });