markdown-text-editor 0.0.1-beta.1 → 0.0.3-beta.1

package/LICENSE

@@ -1,7 +1,21 @@
-Copyright 2024 Nezanuha
+MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Copyright (c) 2025 nezanuha
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,6 @@
-# MarkdownEditor Plugin Documentation
+# markdownEditor Plugin Documentation
 
-This document explains how to use the **MarkdownEditor Plugin**, a customizable, reusable markdown editor with toolbar functionality that allows options like **bold** and **italic** formatting. Users can dynamically set which tools to display and in what order. The plugin is built with Tailwind CSS for styling and provides easy integration into any project.
+This document explains how to use the **markdownEditor Plugin**, a customizable, reusable markdown editor with toolbar functionality that allows options like **bold** and **italic** formatting. Users can dynamically set which tools to display and in what order. The plugin is built with Tailwind CSS for styling and provides easy integration into any project.
 
 ## Table of Contents
 - [Installation](#installation)
@@ -17,17 +17,17 @@ To install the plugin in your project, you can include the plugin JavaScript fil
 
 1. **Install via NPM** (for bundling tools like Webpack):
    ```
-   npm install frutjam
+   npm install markdown-text-editor
    ```
 
 ## Usage
 
 
-Import the `markdownEditor` class from frutjam:
+Import the `markdownEditor` class from markdown-text-editor:
 
 
 ```
-import { markdownEditor } from "frutjam";
+import { markdownEditor } from "markdown-text-editor";
 ```
 
 ### Basic Example:
@@ -41,9 +41,9 @@ To initialize the Markdown editor, you need an empty container (like a `div`) in
 
 #### JavaScript:
 ```javascript
-import { MarkdownEditor } from 'frutjam';
+import { markdownEditor } from 'markdown-text-editor';
 
-const editor = new MarkdownEditor('editor-container', {
+const editor = new markdownEditor('editor-container', {
     placeholder: 'Write your markdown...',
     toolbar: ['bold', 'italic'], // Define the tools you want in the toolbar
 });
@@ -57,7 +57,7 @@ You can specify which formatting options you want in the toolbar. The plugin sup
 
 For example:
 ```javascript
-const editor = new MarkdownEditor('editor-container', {
+const editor = new markdownEditor('editor-container', {
     placeholder: 'Start writing...',
     toolbar: ['bold', 'italic', 'strikethrough', 'preview'],
 });
@@ -82,7 +82,7 @@ The toolbar can be customized to include the following options (you can add more
 Example:
 
 ```javascript
-const editor = new MarkdownEditor('editor-container', {
+const editor = new markdownEditor('editor-container', {
     placeholder: 'Your markdown here...',
     toolbar: ['italic', 'bold'], // Shows italic first, then bold
 });
@@ -106,7 +106,7 @@ const editor = new MarkdownEditor('editor-container', {
 
     <script src="dist/markdown-editor-plugin.js"></script>
     <script>
-        const editor = new MarkdownEditor('editor-container', {
+        const editor = new markdownEditor('editor-container', {
             placeholder: 'Type some markdown...',
             toolbar: ['bold', 'italic'] // Toolbar order: bold first, then italic
         });
@@ -120,9 +120,9 @@ const editor = new MarkdownEditor('editor-container', {
 To use the plugin with Webpack, import the plugin and initialize it as shown below:
 
 ```javascript
-import { markdownEditor } from 'frutjam';
+import { markdownEditor } from 'markdown-editor';
 
-const editor = new MarkdownEditor('editor-container', {
+const editor = new markdownEditor('editor-container', {
     placeholder: 'Write markdown...',
     toolbar: ['bold', 'italic'],  // Custom toolbar options
 });
@@ -135,28 +135,6 @@ You can modify the appearance of the editor and toolbar using Tailwind utility c
 - The toolbar and editor area are styled with Tailwind by default.
 - You can override these classes in your custom Tailwind config to suit your design.
 
-## Folder Structure
-
-Here’s a suggested folder structure for your project:
-
-```
-/src
-  /components
-    /editor
-      Toolbar.js        - Handles toolbar creation
-      MarkdownEditor.js - Main editor logic
-    /tools
-      BoldTool.js       - Logic for Bold tool
-      ItalicTool.js     - Logic for Italic tool
-  /styles
-    main.css            - Includes Tailwind CSS
-  main.js               - Entry point, initializes the editor
-/webpack.config.js      - Webpack configuration
-/dist
-  markdown-editor-plugin.js   - Generated JS file (bundled)
-  markdown-editor-plugin.css  - Generated CSS file
-```
-
 ## Conclusion
 
-This **MarkdownEditor Plugin** allows easy setup of markdown editing with dynamic toolbar controls, making it flexible and reusable for various projects.
+This **markdownEditor Plugin** allows easy setup of markdown editing with dynamic toolbar controls, making it flexible and reusable for various projects.