8
0
فهرست منبع

Docs: Package page and README. [skip ci]

Piotrek Koszuliński 8 سال پیش
والد
کامیت
818f5ea112
2فایلهای تغییر یافته به همراه32 افزوده شده و 2 حذف شده
  1. 2 2
      packages/ckeditor5-upload/README.md
  2. 30 0
      packages/ckeditor5-upload/docs/api/upload.md

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

@@ -1,4 +1,4 @@
-CKEditor 5 upload feature
+CKEditor 5 file upload utils
 ========================================
 
 [![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 upload feature
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-upload/status.svg)](https://david-dm.org/ckeditor/ckeditor5-upload)
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-upload/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-upload?type=dev)
 
-Upload Feature for CKEditor 5. More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-upload>.
+File upload utils for CKEditor 5. More information about the project can be found at the following URL: <https://github.com/ckeditor/ckeditor5-upload>.
 
 ## License
 

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

@@ -0,0 +1,30 @@
+---
+category: api-reference
+---
+
+# CKEditor 5 file upload uitls
+
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-upload.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-upload)
+
+This package implements various file upload utils for CKEditor 5.
+
+## Documentation
+
+See the {@link module:upload/filerepository~FileRepository} plugin documentation.
+
+## Installation
+
+```bash
+npm install --save @ckeditor/ckeditor5-upload
+```
+
+## Contribute
+
+The source code of this package is available on GitHub in https://github.com/ckeditor/ckeditor5-upload.
+
+## External links
+
+* [`@ckeditor/ckeditor5-upload` on npm](https://www.npmjs.com/package/@ckeditor/ckeditor5-upload)
+* [`ckeditor/ckeditor5-upload` on GitHub](https://github.com/ckeditor/ckeditor5-upload)
+* [Issue tracker](https://github.com/ckeditor/ckeditor5-upload/issues)
+* [Changelog](https://github.com/ckeditor/ckeditor5-upload/blob/master/CHANGELOG.md)