Parcourir la source

Docs: Added proper keywords and minor tweaks.

Piotrek Koszuliński il y a 8 ans
Parent
commit
7dd01225e3

+ 2 - 2
packages/ckeditor5-ui/README.md

@@ -1,4 +1,4 @@
-CKEditor 5 UI framework and default library
+CKEditor 5 UI framework
 ===========================================
 
 [![Join the chat at https://gitter.im/ckeditor/ckeditor5](https://badges.gitter.im/ckeditor/ckeditor5.svg)](https://gitter.im/ckeditor/ckeditor5?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -8,7 +8,7 @@ CKEditor 5 UI framework and default library
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-ui/status.svg)](https://david-dm.org/ckeditor/ckeditor5-ui)
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-ui/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-ui?type=dev)
 
-The UI framework of CKEditor 5. More information about the project can be found at the following url: <https://github.com/ckeditor/ckeditor5>.
+The UI framework and standard library of CKEditor 5. More information about the project can be found at the following url: <https://github.com/ckeditor/ckeditor5>.
 
 ## License
 

+ 30 - 0
packages/ckeditor5-ui/docs/api/ui.md

@@ -0,0 +1,30 @@
+---
+category: api-reference
+---
+
+# CKEditor 5 UI framework
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-ui.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-ui)
+
+This package implements a simple UI framework and CKEditor 5's standard UI library.
+
+## Documentation
+
+See the introduction to the {@link framework/guides/architecture/intro#UI-library UI library architecture}.
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-ui
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-ui.
+
+## External links
+
+* [`@ckeditor/ckeditor5-ui` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-ui)
+* [`ckeditor/ckeditor5-ui` on GitHub](https://github.com/ckeditor/ckeditor5-ui)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-ui/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-ui/blob/master/CHANGELOG.md)

+ 3 - 2
packages/ckeditor5-ui/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@ckeditor/ckeditor5-ui",
   "version": "0.10.0",
-  "description": "The UI framework of CKEditor 5.",
+  "description": "The UI framework and standard UI library of CKEditor 5.",
   "keywords": [
-    "CKEditor"
+    "ckeditor5",
+    "ckeditor5-lib"
   ],
   "dependencies": {
     "@ckeditor/ckeditor5-core": "^0.9.0",