Просмотр исходного кода

Update readme pages for npm (#2527)

* Update zoom readme for npm page

* Update provider plugin readme files
mokutsu-coursera 4 лет назад
Родитель
Сommit
497605f1d4

+ 3 - 1
packages/@uppy/dropbox/README.md

@@ -5,7 +5,9 @@
 <a href="https://www.npmjs.com/package/@uppy/dropbox"><img src="https://img.shields.io/npm/v/@uppy/dropbox.svg?style=flat-square"></a>
 <a href="https://travis-ci.org/transloadit/uppy"><img src="https://img.shields.io/travis/transloadit/uppy/master.svg?style=flat-square" alt="Build Status"></a>
 
-A description of this plugin or module goes here.
+The Dropbox plugin for Uppy lets users import files from their Dropbox account.
+
+A Companion instance is required for the Dropbox plugin to work. Companion handles authentication with Dropbox, downloads files from Dropbox and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection.
 
 Uppy is being developed by the folks at [Transloadit](https://transloadit.com), a versatile file encoding service.
 

+ 4 - 1
packages/@uppy/facebook/README.md

@@ -5,7 +5,10 @@
 <a href="https://www.npmjs.com/package/@uppy/facebook"><img src="https://img.shields.io/npm/v/@uppy/facebook.svg?style=flat-square"></a>
 <a href="https://travis-ci.org/transloadit/uppy"><img src="https://img.shields.io/travis/transloadit/uppy/master.svg?style=flat-square" alt="Build Status"></a>
 
-A description of this plugin or module goes here.
+The Facebook plugin for Uppy lets users import files from their Facebook account.
+
+A Companion instance is required for the Facebook plugin to work. Companion handles authentication with Facebook, downloads files from Facebook and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection.
+
 
 Uppy is being developed by the folks at [Transloadit](https://transloadit.com), a versatile file encoding service.
 

+ 3 - 1
packages/@uppy/onedrive/README.md

@@ -5,7 +5,9 @@
 <a href="https://www.npmjs.com/package/@uppy/facebook"><img src="https://img.shields.io/npm/v/@uppy/facebook.svg?style=flat-square"></a>
 <a href="https://travis-ci.org/transloadit/uppy"><img src="https://img.shields.io/travis/transloadit/uppy/master.svg?style=flat-square" alt="Build Status"></a>
 
-A description of this plugin or module goes here.
+The OneDrive plugin for Uppy lets users import files from their OneDrive account.
+
+A Companion instance is required for the OneDrive plugin to work. Companion handles authentication with Microsoft OneDrive, downloads files from OneDrive and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection.
 
 Uppy is being developed by the folks at [Transloadit](https://transloadit.com), a versatile file encoding service.
 

+ 3 - 1
packages/@uppy/zoom/README.md

@@ -5,7 +5,9 @@
 <a href="https://www.npmjs.com/package/@uppy/zoom"><img src="https://img.shields.io/npm/v/@uppy/zoom.svg?style=flat-square"></a>
 <a href="https://travis-ci.org/transloadit/uppy"><img src="https://img.shields.io/travis/transloadit/uppy/master.svg?style=flat-square" alt="Build Status"></a>
 
-A description of this plugin or module goes here.
+The Zoom plugin for Uppy lets users import recordings and related files from their Zoom account.
+
+A Companion instance and zoom account with cloud recordings is required for the Zoom plugin to work. Companion handles authentication with Zoom, downloads files from Zoom and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection.
 
 Uppy is being developed by the folks at [Transloadit](https://transloadit.com), a versatile file encoding service.