lulichat 1.0.1

package/README.md

@@ -0,0 +1,68 @@
+# Lulichat Support Chat
+
+Lulichat Support Chat is a React library that provides a chat interface for web applications. It includes a chat icon that opens a contact form for users to submit their contact information, and it establishes a socket connection for real-time chat functionality.
+
+## Features
+
+- Chat icon positioned at the bottom right corner of the screen.
+- Contact information collection form with validation.
+- Real-time chat interface using WebSocket.
+- Easy integration into any React application.
+
+## Installation
+
+To install the Lulichat Support Chat library, run the following command:
+
+```bash
+npm install lulichat
+```
+
+## Usage
+
+To use the Lulichat Support Chat in your application, import the components as follows:
+
+```tsx
+import Lulichat from "lulichat";
+```
+
+### Example
+
+```tsx
+import React from "react";
+import Lulichat from "lulichat";
+
+const App = () => {
+  return (
+    <div>
+      <h1>Welcome to My Application</h1>
+      <LuliChat
+        apiKey="LU...."
+        companyName="LuliChat Demo"
+        welcomeMessage="How can we help you today?"
+        primaryColor="#4f46e5"
+        allowAnonymous={true}
+        requireContactInfo={true}
+        position="bottom-right"
+      />
+    </div>
+  );
+};
+
+export default App;
+```
+
+## API
+
+### Components
+
+- **ChatIcon**: Renders a chat icon that opens the contact form.
+- **ContactForm**: Displays a form for users to input their contact details.
+- **SupportChat**: Manages the chat interface and socket connection.
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
+
+## License
+
+This project is licensed under the MIT License. See the LICENSE file for more details.