From b6506918489d2b4d7d7fb018f7f08b053f50339d Mon Sep 17 00:00:00 2001 From: Ben Tran Date: Wed, 23 Sep 2026 10:29:38 +0930 Subject: [PATCH 1/4] TINYINT-3453: Update details --- CONTRIBUTING.md | 5 ++++ README.md | 70 ++++++++++++++++++++++++++++++++++++++++--------- package.json | 13 +++++++-- 3 files changed, 73 insertions(+), 15 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..a9a2148 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,5 @@ +# Contributing + +External contributors are free to submit PRs against the `main` branch. + +In order for Tiny to accept your contribution, we will need legal permission from you to use your code. Please email `legal@tiny.cloud` with the subject `CLA request for [your Github username]`. Our legal team will send you a Contributors License Agreement (CLA) which you will need to sign and return. diff --git a/README.md b/README.md index 9b8c1e4..2b152f3 100644 --- a/README.md +++ b/README.md @@ -2,25 +2,69 @@ ## About -This package is a thin wrapper around [TinyMCE](https://github.com/tinymce/tinymce) -to make it easier to use in jQuery. +`tinymce-jquery` is a thin wrapper around [TinyMCE](https://github.com/tinymce/tinymce) to make integration easy and seamless. It automatically pulls `tinymce` from Tiny Cloud CDN unless configured to use a different setup, such as self-hosting the [tinymce NPM package](https://www.npmjs.com/package/tinymce). -The jQuery integration used to be included with the default TinyMCE bundle, -starting with TinyMCE 6 it has been removed from the TinyMCE bundle and will -instead be distributed as an independent npm package. +## Quickstart -* If you need detailed documentation on TinyMCE, see: -[TinyMCE Documentation](https://www.tiny.cloud/docs/). -* For the TinyMCE jQuery Quick Start, see: -[TinyMCE Documentation - jQuery Integration](https://www.tiny.cloud/docs/tinymce/8/jquery-cloud/). -* For our quick demos, check out the TinyMCE jQuery -[Storybook](https://tinymce.github.io/tinymce-jquery/). +### Cloud CDN +In your project: -### Issues +1. [Sign up for a Tiny Cloud account](https://www.tiny.cloud/pricing/) to receive a Tiny Cloud API key. +2. Include the following script tags to load jQuery, TinyMCE, and the jQuery integration: -Have you found an issue with tinymce-jquery or do you have a feature request? +```html + + + +``` + +3. Add a `textarea` to target and initialize the editor: + +```html + + + +``` + +4. Update the `your-api-key` placeholders to include your Tiny Cloud API key. + +For more information: [Using TinyMCE with jQuery - Cloud CDN](https://www.tiny.cloud/docs/tinymce/latest/jquery-cloud/) + +### Self hosted via NPM package + +Using TinyMCE from NPM in a jQuery project requires a couple of extra steps. See the documentation for more information: [Using TinyMCE with jQuery - Self hosted via NPM](https://www.tiny.cloud/docs/tinymce/latest/jquery-pm/) + +## Demos + +For our quick demos, check out the TinyMCE jQuery [Storybook](https://tinymce.github.io/tinymce-jquery/). + +## Detailed documentation + +* [TinyMCE Documentation](https://www.tiny.cloud/docs/tinymce/latest/). + +## Issues + +Have you found an issue with `tinymce-jquery` or do you have a feature request? Open up an [issue](https://github.com/tinymce/tinymce-jquery/issues) and let us know or submit a [pull request](https://github.com/tinymce/tinymce-jquery/pulls). *Note: For issues concerning TinyMCE please visit the [TinyMCE repository](https://github.com/tinymce/tinymce).* + +## License + +`tinymce-jquery` is licensed under the MIT License. See the LICENSE.txt file for details. + +Depending on use case, the TinyMCE core editor can be used under either GPL-2.0-or-later or a commercial license. See the [tinymce package](https://www.npmjs.com/package/tinymce) for details. diff --git a/package.json b/package.json index f363d9d..28bc852 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,16 @@ { "name": "@tinymce/tinymce-jquery", "version": "2.3.0-rc", - "description": "Official TinyMCE integration for jQuery", + "description": "Official jQuery integrationn for TinyMCE rich text editor.", + "keywords": [ + "tinymce", + "jquery", + "editor", + "wysiwyg", + "rich-text-editor", + "html", + "javascript" + ], "main": "dist/tinymce-jquery.js", "files": [ "dist", @@ -24,7 +33,7 @@ "deploy-storybook": "yarn storybook-to-ghpages --source-branch=main" }, "repository": "https://github.com/tinymce/tinymce-jquery", - "author": "Tiny Technologies", + "author": "Ephox Corporation DBA Tiny Technologies, Inc.", "license": "MIT", "devDependencies": { "@ephox/agar": "^7.4.1", From cb69099459e16fd9e5313d0e8416a81149123b2b Mon Sep 17 00:00:00 2001 From: Ben Tran Date: Fri, 25 Sep 2026 07:52:11 +0930 Subject: [PATCH 2/4] Update About --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2b152f3..ceb209e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## About -`tinymce-jquery` is a thin wrapper around [TinyMCE](https://github.com/tinymce/tinymce) to make integration easy and seamless. It automatically pulls `tinymce` from Tiny Cloud CDN unless configured to use a different setup, such as self-hosting the [tinymce NPM package](https://www.npmjs.com/package/tinymce). +Official jQuery integration for TinyMCE, the rich text editor. It adds a custom `.tinymce()` function to jQuery so an editor can be initialized by invoking `$().tinymce()`. By default, it pulls TinyMCE from the Tiny Cloud CDN unless configured to use a different setup, such as self-hosting the [tinymce NPM package](https://www.npmjs.com/package/tinymce). ## Quickstart From 9c969b856ec508d116d3d402e9e8f08ae97a6daa Mon Sep 17 00:00:00 2001 From: Ben Tran Date: Fri, 25 Sep 2026 10:45:12 +0930 Subject: [PATCH 3/4] Update quickstart structure --- README.md | 59 ++++++++++++++++++++++++++----------------------------- 1 file changed, 28 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index ceb209e..8702269 100644 --- a/README.md +++ b/README.md @@ -8,38 +8,35 @@ Official jQuery integration for TinyMCE, the rich text editor. It adds a custom ### Cloud CDN -In your project: - 1. [Sign up for a Tiny Cloud account](https://www.tiny.cloud/pricing/) to receive a Tiny Cloud API key. -2. Include the following script tags to load jQuery, TinyMCE, and the jQuery integration: - -```html - - - -``` - -3. Add a `textarea` to target and initialize the editor: - -```html - - - -``` - -4. Update the `your-api-key` placeholders to include your Tiny Cloud API key. +1. Then in your project: + 1. Include the following script tags to load jQuery, TinyMCE, and the jQuery integration: + + ```html + + + + ``` + 1. Add a `textarea` to target and initialize the editor: + + ```html + + + + ``` + 1. Update the `your-api-key` placeholders to include your Tiny Cloud API key. For more information: [Using TinyMCE with jQuery - Cloud CDN](https://www.tiny.cloud/docs/tinymce/latest/jquery-cloud/) From 361a5297ee3a73014e6ac73b0bf9922c25aca3a7 Mon Sep 17 00:00:00 2001 From: tiny-ben-tran Date: Fri, 25 Sep 2026 14:05:05 +0930 Subject: [PATCH 4/4] Update package.json Co-authored-by: Millie --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 28bc852..c95da5a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@tinymce/tinymce-jquery", "version": "2.3.0-rc", - "description": "Official jQuery integrationn for TinyMCE rich text editor.", + "description": "Official jQuery integration for TinyMCE rich text editor.", "keywords": [ "tinymce", "jquery",