@jexity/chat-widget 0.1.0 → 0.2.0-canary.6b459f2

package/README.md

@@ -20,13 +20,32 @@ npm install @jexity/chat-widget
 ```
 
 ```ts
-import { init } from '@jexity/chat-widget'
+import { JexityChat } from '@jexity/chat-widget'
 
-const widget = init({
+const chat = JexityChat({
   orgId: 'YOUR_ORG_ID',
 })
 
-// Later: widget.destroy()
+// Later: chat.shutdown()
+```
+
+### React Provider
+
+```tsx
+import { JexityChatProvider, useJexityChat } from '@jexity/chat-widget/react'
+
+function App() {
+  return (
+    <JexityChatProvider orgId="YOUR_ORG_ID">
+      <HomePage />
+    </JexityChatProvider>
+  )
+}
+
+function HomePage() {
+  const { open, close, toggle, isOpen } = useJexityChat()
+  return <button onClick={open}>Chat with us</button>
+}
 ```
 
 ## Configuration
@@ -44,12 +63,23 @@ const widget = init({
 ## Programmatic API
 
 ```ts
-const widget = init(options)
+const chat = JexityChat(options)
 
-widget.open()    // Open the chat window
-widget.close()   // Close the chat window
-widget.toggle()  // Toggle open/closed
-widget.destroy() // Remove widget from DOM
+chat.open()      // Open the chat window
+chat.close()     // Close the chat window
+chat.toggle()    // Toggle open/closed
+chat.shutdown()  // Remove widget from DOM
+chat.isOpen      // readonly boolean
+```
+
+## Script Tag Global
+
+```html
+<script src="https://cdn.jexity.chat/widget/latest/widget.js" data-org-id="YOUR_ORG_ID"></script>
+<script>
+  window.JexityChat.open()
+  window.JexityChat.shutdown()
+</script>
 ```
 
 ## License