瀏覽代碼

Docs: Improved keywords and the readme. [skip ci]

Piotrek Koszuliński 7 年之前
父節點
當前提交
09ae1cb368
共有 2 個文件被更改,包括 19 次插入9 次删除
  1. 15 1
      packages/ckeditor5-engine/README.md
  2. 4 8
      packages/ckeditor5-engine/package.json

+ 15 - 1
packages/ckeditor5-engine/README.md

@@ -12,9 +12,23 @@ CKEditor 5 editing engine
 
 The CKEditor 5 editing engine implements a flexible MVC-based architecture for creating rich text editing features.
 
+## Architecture overview
+
+* **Custom data model.** CKEditor 5 implements a tree-structured custom data model, designed to fit multiple requirements such as enabling real-time collaboration and complex editing features (like tables or nested blocks).
+* **Virtual DOM.** CKEditor 5's editing engine features a custom, editing-oriented virtual DOM implementation that aims to hide browser quirks from your sight. **No more `contentEditable` nightmares!**
+* **Real-time collaborative editing**. The editor implements Operational Transformation for the tree-structured model as well as many other mechanisms which were required to create a seamless collaborative UX. Additionally, we provide cloud infrastructure and plugins enabling real-time collaborative editing in your application! [Check the collaboration demo](https://docs.ckeditor.com/ckeditor5/latest/features/collaboration/overview.html).
+* **Extensible.** The entire editor architecture was designed for maximum flexibility. The code is event-based and highly decoupled, allowing you to plug in or replace selected pieces. Features do not directly depend on each other and communicate in standardized ways.
+* **Schema-less core**. The core makes minimal assumptions and can be controlled through the schema. This leaves all decisions to plugins and to you.
+* **Modular architecture.** Not only can the core modules be reused and recomposed but even the features were implemented in a highly granular way. Feel like running a headless CKEditor 5 with a couple of features in Node.js? Not a problem!
+* **Framework for building rich-text editors.** Every use case is different and every editor needs to fulfill different goals. Therefore, we give you the freedom to create your own editors with custom-tailored features and UI.
+* **Heavily tested from day one.** CKEditor 5 comes with 3x more tests than React itself. All packages have 100% code coverage.
+* **8+ years of support.** It is not yet another framework to be gone next year or a hyped proof-of-concept to fail in a real-life scenario. We have over 15 years of experience in creating rich text editors and invested over 4 years in designing and building your next future-proof rich text editor of choice.
+
 ## Documentation
 
-See the [`@ckeditor/ckeditor5-engine` package](https://docs.ckeditor.com/ckeditor5/latest/api/engine.html) page in [CKEditor 5 documentation](https://docs.ckeditor.com/ckeditor5/latest/).
+For general introduction see the [Overview of CKEditor 5 framework](https://docs.ckeditor.com/ckeditor5/latest/framework/guides/overview.html) guide and then the [Editing engine architecture](https://docs.ckeditor.com/ckeditor5/latest/framework/guides/architecture/editing-engine.html) guide.
+
+Additionally, see the [`@ckeditor/ckeditor5-engine` package](https://docs.ckeditor.com/ckeditor5/latest/api/engine.html) page in [CKEditor 5 documentation](https://docs.ckeditor.com/ckeditor5/latest/) for even more information.
 
 ## License
 

+ 4 - 8
packages/ckeditor5-engine/package.json

@@ -1,17 +1,14 @@
 {
   "name": "@ckeditor/ckeditor5-engine",
   "version": "10.1.0",
-  "description": "CKEditor 5 editing engine.",
+  "description": "The editing engine of CKEditor 5 – the best browser-based rich text editor.",
   "keywords": [
     "ckeditor5-lib",
-    "CKEditor",
+    "ckeditor",
     "ckeditor5",
     "ckeditor 5",
-    "WYSIWYG",
-    "WYSIWYM",
-    "text",
-    "rich-text",
-    "richtext",
+    "wysiwyg",
+    "rich text",
     "editor",
     "html",
     "contentEditable",
@@ -21,7 +18,6 @@
     "collaboration",
     "collaborative",
     "real-time",
-    "virtual dom",
     "framework"
   ],
   "dependencies": {