@viveksinghind/narrative-form-react 1.0.1 → 1.0.4

package/README.md

@@ -1,6 +1,6 @@
 # @viveksinghind/narrative-form-react
 
-React components for Narrative Form — a beautiful, typewriter-style signup flow.
+React integration for Narrative Form, a dynamic typewriter-style sign-up flow.
 
 ## Installation
 
@@ -8,30 +8,44 @@ React components for Narrative Form — a beautiful, typewriter-style signup flo
 npm install @viveksinghind/narrative-form-react @viveksinghind/narrative-form-core
 ```
 
-## Features
-
-- 💅 Beautiful, animated typewriter UI out of the box
-- ⚡️ Built on top of a robust core state machine
-- 🎨 Fully customizable and themeable
-- 📱 Responsive and accessible
-
-## Basic Usage
+## Usage
 
 ```tsx
+import React from 'react';
 import { NarrativeForm } from '@viveksinghind/narrative-form-react';
-import '@viveksinghind/narrative-form-react/dist/index.css';
 
-const formConfig = {
-  // your form configuration
+const myFormConfig = {
+  form: { id: "test", name: "Test Form", version: 1 },
+  welcome: {
+    heading: "Welcome to the future",
+    subtext: "Let's get started",
+    ctaLabel: "Begin"
+  },
+  fields: [
+    {
+      key: "name",
+      type: "text",
+      prefix: "Hi, my name is",
+      validation: { required: true }
+    }
+  ],
+  done: {
+    message: "All done! Thank you.",
+  }
 };
 
-function App() {
+export default function App() {
   return (
-    <NarrativeForm config={formConfig} onComplete={(data) => console.log(data)} />
+    <NarrativeForm 
+      config={myFormConfig} 
+      onComplete={(values) => console.log('Form Complete!', values)} 
+    />
   );
 }
 ```
 
-## License
-
-MIT
+## Features
+- Fully typed React components
+- Smooth CSS animations for the typewriter effect
+- Accessible form elements
+- Themeable via config