v1.0.0 release

Author: Mgsy

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## 1.0.0 (September 19, 2024)
+
+We are happy to announce the release of CKEditor 5 Official Integration v1.0.0.
+
+### Release highlights
+
+This release introduces compatibility between the CKEditor 5 Official Integration plugin and Strapi 5. Since Strapi 5 is currently in its Release Candidate (RC) phase (as of September 19th), we are providing an updated version of the plugin to allow early testing and ensure seamless integration with the upcoming Strapi 5 release.
+
+For users who continue to work with Strapi 4, the plugin remains available in version 0.x.x (with 0.1.0 being the latest as of September 19th). This ensures full support for Strapi 4 environments.
+
+### BREAKING CHANGES ℹ️
+
+* **CKEditor 5 integration now uses CDN instead of npm**. In version 1.0.0, we've transitioned from npm packages to loading CKEditor 5 via the CKEditor CDN. As the editor will now be loaded from an external origin, you'll need to update your Content Security Policy (CSP) to include https://cdn.ckeditor.com in the `script-src` directive. Please see the updated installation instructions in the `README.md` for further details.

LICENSE.md

@@ -5,7 +5,7 @@ Copyright (c) 2022-2024, [CKSource Holding sp. z o.o.](http://cksource.com) All
 
 Inspired by https://github.com/nshenderov/strapi-plugin-ckeditor, copyright nshenderov.
 
-Licensed under the terms of [MIT License](https://opensource.org/licenses/MIT).
+The plugin "CKEditor 5 - Official Integration for Strapi" is licensed the terms of the [MIT License](https://opensource.org/licenses/MIT). Please note that [CKEditor 5 itself is licensed under GPL v2+](https://ckeditor.com/legal/ckeditor-oss-license/?utm_campaign=strapi-integration&utm_source=ck-github&utm_medium=referral) or a [commercial license](https://ckeditor.com/pricing/?utm_campaign=strapi-integration&utm_source=ck-github&utm_medium=referral).
 
 Trademarks
 ----------

README.md

@@ -1,8 +1,11 @@
-# CKEditor 5 custom field for Strapi
+# CKEditor 5 - Official Integration for Strapi
 
 <img src="https://user-images.githubusercontent.com/156149/192792402-4bb1e040-6f8c-49be-af90-fd35fd3a4c66.png" alt="CKEditor 5 used inside Strapi. Article form consisting of a title, excerpt text, and content">
 
-This package provides a custom field for Strapi that lets you use and configure CKEditor in no time.
+> [!IMPORTANT]  
+> Starting from version 1.0.0, the CKEditor 5 custom field plugin is compatible with Strapi 5 and can’t be used in Strapi 4.4+. We decided to maintain integrations for both Strapi versions to ensure that you can still use our custom field before migrating to Strapi 5. Below is the [compatibility table](#compatibility) showing which plugin version should be used with your Strapi version.
+
+This package provides a custom field for Strapi 5 that lets you use and configure CKEditor in no time.
 
 Custom fields are supported since Strapi 4.4+ and offer powerful API to create highly customizable fields.
 
@@ -33,7 +36,26 @@ With `yarn`:
 yarn add @ckeditor/strapi-plugin-ckeditor
 ```
 
-Then run build:
+Then, add the Content Security Policy configuration to allow loading CKEditor 5 from https://cdn.ckeditor.com origin, by adding the rule to `config/middlewares.ts` in your Strapi project root:
+
+```js
+export default [
+  // ...
+  {
+    name: 'strapi::security',
+    config: {
+      contentSecurityPolicy: {
+        useDefaults: true,
+        directives: {
+          'script-src': ['https://cdn.ckeditor.com']
+        },
+      },
+    },
+  },
+  // ...
+```
+
+Finally run build:
 
 ```bash
 npm run build
@@ -100,3 +122,42 @@ Rebuild the project and start the server:
 yarn build
 yarn develop
 ```
+
+## <a id="compatibility"></a>🧩 Compatibility with Strapi versions
+
+Starting from version 1.0.0, the CKEditor 5 custom field plugin is compatible with Strapi 5 and can't be used in Strapi 4.4+. We decided to maintain integrations for both Strapi versions to make sure that you still be able to use our custom field before migrating to Strapi 5. Below, you can find the compatibility table that shows which plugin version should be used with your Strapi version.
+
+ <table>
+    <thead>
+        <tr>
+            <th>
+                Plugin version
+            </th>
+            <th>
+                Strapi version
+            </th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>
+                1.x.x
+            </td>
+            <td>
+                ≥ 5.0.0
+            </td>
+        </tr>
+        <tr>
+            <td>
+                0.x.x
+            </td>
+            <td>
+                ≥ 4.4
+            </td>
+        </tr>
+    </tbody>
+</table>
+
+## <a id="licensing"></a>⚖️ Licensing
+
+The plugin "CKEditor 5 - Official Integration for Strapi" is licensed under MIT. Please note that [CKEditor 5 itself is licensed under GPL v2+](https://ckeditor.com/legal/ckeditor-oss-license/?utm_campaign=strapi-integration&utm_source=ck-github&utm_medium=referral) or a [commercial license](https://ckeditor.com/pricing/?utm_campaign=strapi-integration&utm_source=ck-github&utm_medium=referral).