Browse Source

Docs: README and front API docs page corrected. [skip ci]

Anna Tomanek 8 years ago
parent
commit
1b4bb9dec5

+ 1 - 1
packages/ckeditor5-widget/README.md

@@ -8,7 +8,7 @@ CKEditor 5 widget API
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-widget/status.svg)](https://david-dm.org/ckeditor/ckeditor5-widget)
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-widget/status.svg)](https://david-dm.org/ckeditor/ckeditor5-widget)
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-widget/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-widget?type=dev)
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-widget/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-widget?type=dev)
 
 
-This package implements widget API for CKEditor 5.
+This package implements the widget API for CKEditor 5.
 
 
 ## Documentation
 ## Documentation
 
 

+ 4 - 4
packages/ckeditor5-widget/docs/api/widget.md

@@ -6,18 +6,18 @@ category: api-reference
 
 
 [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-widget.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-widget)
 [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-widget.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-widget)
 
 
-This package implements widget API for CKEditor 5.
+This package implements the widget API for CKEditor 5.
 
 
-The API consists of a couple of primitives and helpers which make it easy to implement rich content units such as images with caption.
+The API consists of a few primitives and helpers that make it easy to implement rich content units such as images with captions.
 
 
 ## Documentation
 ## Documentation
 
 
 Browse the API documentation of this package by using the module tree on the left.
 Browse the API documentation of this package by using the module tree on the left.
 
 
 <info-box>
 <info-box>
-	The widget API is proposed in a very different way than what you might remember from CKEditor 4. It is just a set of utils which allows you to implement typical object-like entities. Most of the work actually happens in the {@link api/engine engine} and this API's role is only to properly conduct the engine.
+	The widget API is proposed in a very different way than it was in CKEditor 4. It is just a set of utilities that allow you to implement typical object-like entities. Most of the work actually happens in the {@link api/engine engine} and this API's role is only to properly conduct the engine.
 
 
-	Therefore, this is just one of the ways how widgets can be proposed. We expect this API to change (grow) and for now, the only available documentation is in the {@link module:image/image/imageengine~ImageEngine}'s code (which is the only widget API consumer for now).
+	Therefore, this is just one of the ways how widgets can be proposed. This API can be expected to change (grow) and for now, the only available documentation is in the {@link module:image/image/imageengine~ImageEngine}'s code (which is the only widget API consumer at this stage).
 </info-box>
 </info-box>
 
 
 ## Installation
 ## Installation