@eddyter/core 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +20 -20
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
- # richtext-core-sdk
1
+ # @eddyter/core
2
2
 
3
- [![npm version](https://img.shields.io/npm/v/richtext-core-sdk.svg)](https://www.npmjs.com/package/richtext-core-sdk)
4
- [![npm downloads](https://img.shields.io/npm/dw/richtext-core-sdk.svg)](https://www.npmjs.com/package/richtext-core-sdk)
5
- [![Bundle Size](https://img.shields.io/bundlephobia/minzip/richtext-core-sdk)](https://bundlephobia.com/package/richtext-core-sdk)
3
+ [![npm version](https://img.shields.io/npm/v/@eddyter/core.svg)](https://www.npmjs.com/package/@eddyter/core)
4
+ [![npm downloads](https://img.shields.io/npm/dw/@eddyter/core.svg)](https://www.npmjs.com/package/@eddyter/core)
5
+ [![Bundle Size](https://img.shields.io/bundlephobia/minzip/@eddyter/core)](https://bundlephobia.com/package/@eddyter/core)
6
6
 
7
7
  Plug and Play AI Rich Text Editor for **any** website, blog, CRM, ERP, or web app — built on [Lexical](https://lexical.dev/) with dark mode support and API key authentication. No React knowledge required.
8
8
 
@@ -19,17 +19,17 @@ This is the **framework-agnostic SDK** for the Eddyter editor. It wraps the offi
19
19
  ## Installation
20
20
 
21
21
  ```bash
22
- npm install richtext-core-sdk
22
+ npm install @eddyter/core
23
23
  # or
24
- yarn add richtext-core-sdk
24
+ yarn add @eddyter/core
25
25
  # or
26
- pnpm add richtext-core-sdk
26
+ pnpm add @eddyter/core
27
27
  ```
28
28
 
29
29
  Or include it directly via a CDN as a classic script:
30
30
 
31
31
  ```html
32
- <script src="https://unpkg.com/richtext-core-sdk/dist/editor.iife.js"></script>
32
+ <script src="https://unpkg.com/@eddyter/core/dist/editor.iife.js"></script>
33
33
  ```
34
34
 
35
35
  ### Compatibility
@@ -47,7 +47,7 @@ Or include it directly via a CDN as a classic script:
47
47
  ### 1. Import styles
48
48
 
49
49
  ```js
50
- import 'richtext-core-sdk/style.css';
50
+ import '@eddyter/core/style.css';
51
51
  ```
52
52
 
53
53
  > **Important:** The stylesheet is required for tables, toolbars, and all editor components to render correctly. When the SDK is loaded as a classic script (`editor.iife.js`), the stylesheet is injected automatically by the IIFE bootstrap.
@@ -65,8 +65,8 @@ import 'richtext-core-sdk/style.css';
65
65
  ```
66
66
 
67
67
  ```js
68
- import { init } from 'richtext-core-sdk';
69
- import 'richtext-core-sdk/style.css';
68
+ import { init } from '@eddyter/core';
69
+ import '@eddyter/core/style.css';
70
70
 
71
71
  const apiKey = 'YOUR_API_KEY';
72
72
 
@@ -95,7 +95,7 @@ When loaded via `<script>`, the same API is available on `window.Eddyter`:
95
95
  ```html
96
96
  <div id="editor"></div>
97
97
 
98
- <script src="https://unpkg.com/richtext-core-sdk/dist/editor.iife.js"></script>
98
+ <script src="https://unpkg.com/@eddyter/core/dist/editor.iife.js"></script>
99
99
  <script>
100
100
  const instance = Eddyter.init({
101
101
  container: '#editor',
@@ -327,8 +327,8 @@ If `maxHeight` is not provided, the full page/container scrolls normally with th
327
327
  ### Basic Editor
328
328
 
329
329
  ```js
330
- import { init } from 'richtext-core-sdk';
331
- import 'richtext-core-sdk/style.css';
330
+ import { init } from '@eddyter/core';
331
+ import '@eddyter/core/style.css';
332
332
 
333
333
  init({
334
334
  container: '#editor',
@@ -342,8 +342,8 @@ init({
342
342
  Since the SDK is framework-agnostic, you wire state via the `onChange` callback:
343
343
 
344
344
  ```js
345
- import { init } from 'richtext-core-sdk';
346
- import 'richtext-core-sdk/style.css';
345
+ import { init } from '@eddyter/core';
346
+ import '@eddyter/core/style.css';
347
347
 
348
348
  let content = '<p>Start writing...</p>';
349
349
 
@@ -566,7 +566,7 @@ export const RichTextEditor: React.FC<RichTextEditorProps> = ({
566
566
 
567
567
  ```ts
568
568
  // Entrypoint
569
- import { init } from 'richtext-core-sdk';
569
+ import { init } from '@eddyter/core';
570
570
 
571
571
  // Types
572
572
  import type {
@@ -577,10 +577,10 @@ import type {
577
577
  EddyterToolbarConfig,
578
578
  EddyterEditorOptions,
579
579
  EddyterApiResponse,
580
- } from 'richtext-core-sdk';
580
+ } from '@eddyter/core';
581
581
 
582
582
  // Styles (one-time import at app entry)
583
- import 'richtext-core-sdk/style.css';
583
+ import '@eddyter/core/style.css';
584
584
  ```
585
585
 
586
586
  When loaded as a classic script the SDK is available on `window.Eddyter`:
@@ -593,7 +593,7 @@ window.Eddyter.init({ /* options */ });
593
593
 
594
594
  | Symptom | Fix |
595
595
  |---------|-----|
596
- | Editor renders but toolbars look broken | The stylesheet is missing. Import `richtext-core-sdk/style.css` in the entry that builds production. |
596
+ | Editor renders but toolbars look broken | The stylesheet is missing. Import `@eddyter/core/style.css` in the entry that builds production. |
597
597
  | `Invalid container` thrown | The selector did not resolve, or you passed something that isn't an `HTMLElement`. |
598
598
  | Theme does not switch | Use `instance.update({ darkMode })`; do not remount. |
599
599
  | API key errors | Confirm the key in your env vars and check the network tab for the verification request. |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eddyter/core",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Eddyter SDK — framework-agnostic embeddable editor",
5
5
  "license": "UNLICENSED",
6
6
  "type": "module",