From 00548428449569348fd34fe8a78699e090d4f898 Mon Sep 17 00:00:00 2001 From: AJvanLoon Date: Mon, 30 Jul 2018 16:03:49 +0200 Subject: [PATCH] Some docs polish @arturi --- website/src/docs/providers.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/website/src/docs/providers.md b/website/src/docs/providers.md index 47f14d046..bbbeefca4 100644 --- a/website/src/docs/providers.md +++ b/website/src/docs/providers.md @@ -5,11 +5,13 @@ permalink: docs/providers/ order: 30 --- -The Provider plugins help you connect to your accounts with remote file providers such as [Dropbox](https://dropbox.com), [Google Drive](https://drive.google.com), [Instagram](https://instagram.com) and remote urls (import a file by pasting a direct link to it). Because this requires server to server communication, they work tightly with [uppy-server](https://github.com/transloadit/uppy-server) to manage the server to server authorization for your account. Almost all of the communication (file download/upload) is done on the server-to-server end, so this saves you the stress and bills of data consumption on the client. +The Provider plugins help you connect to your accounts with remote file providers such as [Dropbox](https://dropbox.com), [Google Drive](https://drive.google.com), [Instagram](https://instagram.com) and remote URLs (importing a file by pasting a direct link to it). Because this requires server-to-server communication, they work tightly with [uppy-server](https://github.com/transloadit/uppy-server) to manage the server-to-server authorization for your account. Almost all of the communication (file download/upload) is done on the server-to-server end, so this saves you the stress and bills of data consumption on the client. -As of now, the supported providers are [**Dropbox**](/docs/dropbox), [**GoogleDrive**](/docs/google-drive), [**Instagram**](/docs/instagram), and [**Url**](/docs/url). +As of now, the supported providers are [**Dropbox**](/docs/dropbox), [**GoogleDrive**](/docs/google-drive), [**Instagram**](/docs/instagram), and [**URL**](/docs/url). -Usage of the Provider plugins is not that different from any other *acquirer* plugin, except that it takes an extra option `serverUrl`, which specifies the url to your running `uppy-server`. This allows Uppy to know what server to connect to when server related operations are required by the provider plugin. Here's a quick example. +Usage of the Provider plugins is not that different from any other *acquirer* plugin, except that it takes an extra option `serverUrl`, which specifies the URL to the `uppy-server` that you are running. This allows Uppy to know what server to connect to when server-related operations are required by the provider plugin. + +Here's a quick example: ```js const Uppy = require('@uppy/core') @@ -31,7 +33,7 @@ uppy.use(Dropbox, {target: Dashboard, serverUrl: 'http://localhost:3020'}) const Instagram = require('@uppy/instagram') uppy.use(Instagram, {target: Dashboard, serverUrl: 'http://localhost:3020'}) -// for Url +// for URL const Url = require('@uppy/url') uppy.use(Url, {target: Dashboard, serverUrl: 'http://localhost:3020'}) ```