From 5a9bfe577b9bb4c1abc011bc0ca2f8bd73a67548 Mon Sep 17 00:00:00 2001 From: AJvanLoon Date: Mon, 30 Jul 2018 15:58:09 +0200 Subject: [PATCH] Some docs polish @arturi Should the code snippet right under the Options header have some kind of introduction as to what it is precisely? --- website/src/docs/dropbox.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/website/src/docs/dropbox.md b/website/src/docs/dropbox.md index 0fc411057..438ab341d 100644 --- a/website/src/docs/dropbox.md +++ b/website/src/docs/dropbox.md @@ -6,7 +6,7 @@ module: "@uppy/dropbox" permalink: docs/dropbox/ --- -The `@uppy/dropbox` plugin lets users import files their Dropbox account. +The `@uppy/dropbox` plugin lets users import files from their Dropbox account. An Uppy Server instance is required for the Dropbox plugin to work. Uppy Server handles authentication with Dropbox, downloads the files, and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection. @@ -24,6 +24,8 @@ uppy.use(Dropbox, { This plugin is published as the `@uppy/dropbox` package. +Install from NPM: + ```shell npm install @uppy/dropbox ``` @@ -36,6 +38,8 @@ const Dropbox = Uppy.Dropbox ## Options +The Dropbox plugin has the following configurable options: + ```js uppy.use(Dropbox, { target: Dashboard, @@ -45,7 +49,7 @@ uppy.use(Dropbox, { ### `id: 'Dropbox'` -A unique identifier for this plugin. Defaults to `'Dropbox'`. +A unique identifier for this plugin. It defaults to `'Dropbox'`. ### `target: null` @@ -65,7 +69,7 @@ The valid and authorised URL(s) from which OAuth responses should be accepted. This value can be a `String`, a `Regex` pattern, or an `Array` of both. -This is useful when you have your [Uppy Server](/docs/server) running on multiple hosts. Otherwise the default value should do just fine. +This is useful when you have your [Uppy Server](/docs/server) running on multiple hosts. Otherwise, the default value should do just fine. ### `locale: {}`