Przeglądaj źródła

Internal: Cleaned up basic resources.

Piotrek Koszuliński 8 lat temu
rodzic
commit
733cadaa82

+ 3 - 3
packages/ckeditor5-cloud-services/README.md

@@ -1,5 +1,5 @@
-CKEditor 5 Cloud Services base package
-======================================
+CKEditor 5 Cloud Services
+=========================
 
 [![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)
 [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-cloudservices.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-cloudservices)
@@ -8,7 +8,7 @@ CKEditor 5 Cloud Services base package
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-cloudservices/status.svg)](https://david-dm.org/ckeditor/ckeditor5-cloudservices)
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-cloudservices/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-cloudservices?type=dev)
 
-Base package for CKEditor Cloud Services integration, which handles CKEditor's `cloudservices` configuration and tokens.
+CKEditor 5's [Cloud Services](https://ckeditor.com/ckeditor-cloud-services/) integration layer, which handles `config.cloudServices` and tokens.
 
 ## Documentation
 

+ 10 - 8
packages/ckeditor5-cloud-services/package.json

@@ -1,17 +1,18 @@
 {
   "name": "@ckeditor/ckeditor5-cloudservices",
-  "version": "1.0.0-alpha.1",
-  "description": "Base package for CKEditor 5' Cloud Services.",
+  "version": "0.0.1",
+  "description": "CKEditor 5's Cloud Services integration layer.",
   "keywords": [
-    "ckeditor5"
+    "ckeditor5",
+    "ckeditor5-lib"
   ],
   "dependencies": {
-	"@ckeditor/ckeditor-cloudservices-core": "^0.2.0",
-	"@ckeditor/ckeditor5-core": "^1.0.0-alpha.1",
-	"@ckeditor/ckeditor5-utils": "^1.0.0-alpha.1"
+    "@ckeditor/ckeditor-cloudservices-core": "^0.2.0",
+    "@ckeditor/ckeditor5-core": "^1.0.0-alpha.1",
+    "@ckeditor/ckeditor5-utils": "^1.0.0-alpha.1"
   },
   "devDependencies": {
-	"eslint": "^4.8.0",
+    "eslint": "^4.8.0",
     "eslint-config-ckeditor5": "^1.0.6",
     "husky": "^0.14.3",
     "lint-staged": "^4.2.3"
@@ -29,8 +30,9 @@
     "url": "https://github.com/ckeditor/ckeditor5-cloudservices.git"
   },
   "files": [
+    "lang",
     "src",
-    "tests/_utils"
+    "theme"
   ],
   "scripts": {
     "lint": "eslint --quiet '**/*.js'",

+ 5 - 4
packages/ckeditor5-cloud-services/src/cloudservices.js

@@ -11,8 +11,9 @@ import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 import Token from '@ckeditor/ckeditor-cloudservices-core/src/token/token';
 
 /**
- * Base plugin for CKEditor Cloud Services. It takes care of the `cloudServices` configuration options and initializes
- * the token provider.
+ * Plugin introducing CKEditor 5's Cloud Services integration.
+ * It takes care of the {@link module:cloudservices/cloudservices~CloudServicesConfig `config.cloudService`}
+ * configuration options and initializes the token provider.
  *
  * @extends module:core/plugin~Plugin
  */
@@ -51,7 +52,7 @@ export default class CloudServices extends Plugin {
 
 		/**
 		 * Other plugins use this token for the authorization process. It handles token requesting and refreshing.
-		 * Its value is null when `tokenUrl` is not provided.
+		 * Its value is `null` when {@link module:cloudservices/cloudservices~CloudServicesConfig#tokenUrl} is not provided.
 		 *
 		 * @readonly
 		 * @member {Object|null} #token
@@ -83,7 +84,7 @@ CloudServices.Token = Token;
  * The configuration for all plugins using CKEditor Cloud Services.
  *
  *		ClassicEditor
- *			.create( {
+ *			.create( document.querySelector( '#editor' ), {
  * 				cloudServices: ... // CloudServices config.
  *			} )
  *			.then( ... )