@oix1987/yjd 1.0.0 → 1.0.2

package/README.md

@@ -1,21 +1,30 @@
-# Rich Text Editor
+# @oix1987/yjd - Professional Rich Text Editor
 
-A powerful rich text editor with real-time content change tracking.
+A powerful, commercial-grade rich text editor with real-time content change tracking for web applications. Built with vanilla JavaScript for maximum performance and compatibility.
 
-## Features
+## 🚀 Features
 
-- Rich text formatting (Bold, Italic, Underline, Strikethrough, etc.)
-- Real-time content change tracking with `onChange` callback
-- Modern UI with customizable toolbar
-- Support for images, tables, links, and more
-- TypeScript support
+- **Rich Text Formatting**: Bold, Italic, Underline, Strikethrough, Subscript, Superscript
+- **Advanced Formatting**: Text alignment, line height, font family, text size, background colors
+- **Content Management**: Images, tables, links, lists, emojis, videos
+- **Real-time Tracking**: `onChange` callback for live content monitoring
+- **Modern UI**: Customizable toolbar with intuitive controls
+- **TypeScript Support**: Full type definitions included
+- **Lightweight**: Pure JavaScript implementation, no heavy dependencies
+- **Cross-browser**: Compatible with all modern browsers
 
-## Usage
+## 📦 Installation
 
-### Basic Usage
+```bash
+npm install @oix1987/yjd
+```
+
+## 💻 Usage
+
+### Basic Implementation
 
 ```javascript
-import RichEditor from "./index.js";
+import RichEditor from "@oix1987/yjd";
 
 const editor = new RichEditor("#editor-container", {
   content: "<p>Initial content</p>",
@@ -32,14 +41,33 @@ const editor = new RichEditor("#editor-container", {
 });
 ```
 
-### Options
+### CDN Usage
+
+```html
+<!-- Using jsDelivr CDN -->
+<script src="https://cdn.jsdelivr.net/npm/@oix1987/yjd@1.0.2/dist/rich-editor.min.js"></script>
+<script>
+  const editor = new RichEditor("#editor-container", {
+    // configuration options
+  });
+</script>
+```
+
+### Alternative CDN
+
+```html
+<!-- Using unpkg CDN -->
+<script src="https://unpkg.com/@oix1987/yjd@1.0.2/dist/rich-editor.min.js"></script>
+```
+
+## ⚙️ Configuration Options
 
 | Option        | Type     | Default        | Description                                   |
 | ------------- | -------- | -------------- | --------------------------------------------- |
 | `content`     | string   | null           | Initial content for the editor                |
 | `height`      | number   | 400            | Editor height in pixels                       |
 | `width`       | number   | 800            | Editor width in pixels                        |
-| `theme`       | string   | 'light'        | Editor theme                                  |
+| `theme`       | string   | 'light'        | Editor theme (light/dark)                     |
 | `placeholder` | string   | 'Type here...' | Placeholder text                              |
 | `onChange`    | function | undefined      | Callback function called when content changes |
 
@@ -64,9 +92,9 @@ onChange: (content) => {
 };
 ```
 
-## Events
+## 🎯 Events
 
-The editor also supports event listeners:
+The editor supports comprehensive event handling:
 
 ```javascript
 // Listen for text changes
@@ -74,18 +102,41 @@ editor.on("text-change", (content) => {
   console.log("Text changed:", content);
 });
 
+// Listen for focus events
+editor.on("focus", () => {
+  console.log("Editor focused");
+});
+
 // Remove event listener
 editor.off("text-change", handler);
 ```
 
-## Methods
+## 🔧 API Methods
+
+| Method                | Description              | Parameters                         | Returns  |
+| --------------------- | ------------------------ | ---------------------------------- | -------- |
+| `getContent()`        | Get current HTML content | -                                  | `string` |
+| `setContent(content)` | Set editor content       | `content: string`                  | `void`   |
+| `focus()`             | Focus the editor         | -                                  | `void`   |
+| `on(event, handler)`  | Add event listener       | `event: string, handler: function` | `void`   |
+| `off(event, handler)` | Remove event listener    | `event: string, handler: function` | `void`   |
+
+## 💼 Commercial License
+
+This is a commercial product. For licensing information and pricing, please contact:
+
+- **Author**: Oix1987
+- **License**: ISC (Commercial)
+- **Version**: 1.0.1
+
+## 📄 License
+
+Copyright (c) 2024 Oix1987. All rights reserved.
+
+This software is licensed under the ISC License. Commercial use requires a valid license.
 
-- `getContent()` - Get current HTML content
-- `setContent(content)` - Set editor content
-- `focus()` - Focus the editor
-- `on(event, handler)` - Add event listener
-- `off(event, handler)` - Remove event listener
+## 🆘 Support
 
-## Example
+For technical support, feature requests, or licensing inquiries, please contact the author.
 
 See `index.html` and `main.js` for a complete working example that demonstrates the `onChange` functionality with real-time output display.