ed-widget 1.8.0

package/README.md

@@ -0,0 +1,56 @@
+# EasyDesk Chat Widget
+
+A lightweight, customizable chat widget for React.js applications and websites. Easily integrate real-time customer support via React or embed it directly using a CDN. Perfect for enhancing user engagement and streamlining support.
+
+## 🚀 Features
+
+- Simple JavaScript API for initializing the widget
+- Auto-initialization via `data-*` attributes
+- CDN and NPM support
+- React-based rendering
+- API key-based configuration
+
+---
+
+## 📦 Installation (NPM)
+
+```bash
+npm install ed-widget
+```
+
+### Usage
+
+```jsx
+import Widget from 'ed-widget';
+
+<Widget apiKey="YOUR_API_KEY" />;
+```
+
+---
+
+## 🌐 Usage via CDN
+
+Add the following script to your HTML page:
+
+```html
+<script
+  id="ed-widget"
+  src="https://cdn.jsdelivr.net/npm/ed-widget/dist/ed-widget.js"
+  ed-key="YOUR_API_KEY"
+></script>
+```
+
+### What happens:
+
+- A `div` with the ID `ed-widget` will be created (if not already present).
+- The widget will be auto-initialized using the API key provided in the `ed-key` attribute.
+
+---
+
+## 🛠 Development
+
+Make sure you have React and ReactDOM available in your environment when developing locally.
+
+## 📄 License
+
+MIT