Browse Source

Docs: Added package guide. [skip ci]

Piotrek Koszuliński 8 years ago
parent
commit
10d638da23
1 changed files with 32 additions and 0 deletions
  1. 32 0
      packages/ckeditor5-easy-image/docs/api/easy-image.md

+ 32 - 0
packages/ckeditor5-easy-image/docs/api/easy-image.md

@@ -0,0 +1,32 @@
+---
+category: api-reference
+---
+
+# CKEditor 5 Easy Image with Cloud Services
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-easy-image.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-easy-image)
+
+This package implements the {@link features/image#Image-upload Easy Image} feature with [Cloud Services](https://ckeditor.com/ckeditor-cloud-services/) integration.
+
+## Documentation
+
+See the {@link features/image#Image-upload Image upload} section in the {@link features/image Image feature} guide.
+
+You can also check the {@link module:easy-image/easyimage~EasyImage} plugin documentation.
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-easy-image
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-easy-image.
+
+## External links
+
+* [`@ckeditor/ckeditor5-easy-image` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-easy-image)
+* [`ckeditor/ckeditor5-easy-image` on GitHub](https://github.com/ckeditor/ckeditor5-easy-image)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-easy-image/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-easy-image/blob/master/CHANGELOG.md)