Mirrors/uppy
1
0
Fork 0
mirror of https://github.com/transloadit/uppy.git synced 2026-07-27 04:05:10 +00:00
Code Issues Projects Releases Wiki Activity

Some docs polish

Browse source 
@arturi 

Should the code snippet right under the Options header have some kind of introduction as to what it is precisely?
This commit is contained in:
AJvanLoon 2018-07-30 16:00:26 +02:00 • committed by GitHub
parent 5a9bfe577b
commit 394f74470b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
website/src/docs/instagram.md
View file

@ -6,7 +6,7 @@ module: "@uppy/instagram"
permalink: docs/instagram/
---
The `@uppy/instagram` plugin lets users import files their Instagram account.
The `@uppy/instagram` plugin lets users import files from their Instagram account.
An Uppy Server instance is required for the `@uppy/instagram` plugin to work. Uppy Server handles authentication with Instagram, downloads the pictures and videos, and uploads them to the destination. This saves the user bandwidth, especially helpful if they are on a mobile connection.
@ -26,6 +26,8 @@ uppy.use(Instagram, {
This plugin is published as the `@uppy/instagram` package.
Install from NPM:
```shell
npm install @uppy/instagram
```
@ -38,6 +40,8 @@ const Instagram = Uppy.Instagram
## Options
The Instagram plugin has the following configurable options:
```js
uppy.use(Instagram, {
target: Dashboard,
@ -47,7 +51,7 @@ uppy.use(Instagram, {
### `id: 'Instagram'`
A unique identifier for this plugin. Defaults to `'Instagram'`.
A unique identifier for this plugin. It defaults to `'Instagram'`.
### `target: null`
@ -67,7 +71,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 be good enough.
This is useful when you have your [Uppy Server](/docs/server) running on multiple hosts. Otherwise, the default value should be good enough.
### `locale: {}`