Pārlūkot izejas kodu

Some docs polish

@arturi
AJvanLoon 6 gadi atpakaļ
vecāks
revīzija
261861f449
1 mainītis faili ar 10 papildinājumiem un 8 dzēšanām
  1. 10 8
      website/src/docs/tus.md

+ 10 - 8
website/src/docs/tus.md

@@ -5,7 +5,7 @@ title: "Tus"
 permalink: docs/tus/
 permalink: docs/tus/
 ---
 ---
 
 
-The Tus plugin brings [tus.io](http://tus.io) resumable file uploading to Uppy by wrapping the [tus-js-client][].
+The Tus plugin brings resumable file uploading by [tus.io](http://tus.io) to Uppy by wrapping the [tus-js-client][].
 
 
 ```js
 ```js
 const Tus = require('@uppy/tus')
 const Tus = require('@uppy/tus')
@@ -22,36 +22,38 @@ uppy.use(Tus, {
 
 
 This plugin is published as the `@uppy/tus` package.
 This plugin is published as the `@uppy/tus` package.
 
 
+Install from NPM:
+
 ```shell
 ```shell
 npm install @uppy/tus
 npm install @uppy/tus
 ```
 ```
 
 
 ## Options
 ## Options
 
 
-The Tus plugin supports all of [tus-js-client][]’s options. Additionally:
+The Tus plugin supports all of [tus-js-client][]’s options. In addition tot that, it has the following configurable options:
 
 
 ### `id: 'Tus'`
 ### `id: 'Tus'`
 
 
-A unique identifier for this plugin. Defaults to `'Tus'`.
+A unique identifier for this plugin. It defaults to `'Tus'`.
 
 
 ### `resume: true`
 ### `resume: true`
 
 
-A boolean indicating whether tus should attempt to resume the upload if the upload has been started in the past. This includes storing the file’s upload url. Use false to force an entire reupload.
+A boolean indicating whether Tus should attempt to resume the upload if the upload has been started in the past. This includes storing the file’s upload URL. Set to false to force an entire reupload.
 
 
-Note that this option is about resuming when you start an upload again with the same file, or when using [GoldenRetriever](/docs/golden-retriever/), which will attempt to restore upload state to what it was before page refresh / browser crash. Even if you set `resume: false` when using Tus uploader, users will still be able to pause/resume an ongoing upload.
+Note that this option is about resuming when you start an upload again with the same file, or when using the [GoldenRetriever](/docs/golden-retriever/) plugin, which will attempt to restore upload state to what it was before page refresh / browser crash. Even if you set `resume: false` when using the Tus uploader, users will still be able to pause/resume an ongoing upload.
 
 
 In most cases you should leave this option as is, relax, and enjoy resumable uploads.
 In most cases you should leave this option as is, relax, and enjoy resumable uploads.
 
 
 ### `endpoint: ''`
 ### `endpoint: ''`
 
 
-URL to upload to, where your tus.io server is running.
+Destination URL for your uploads. This should be where your tus.io server is running.
 
 
 ### `autoRetry: true`
 ### `autoRetry: true`
 
 
-Whether to auto-retry the upload when the user's internet connection is back online after an outage.
+Configures whether or not to auto-retry the upload when the user's internet connection is back online after an outage.
 
 
 ### `limit: 0`
 ### `limit: 0`
 
 
-Limit the amount of uploads going on at the same time. Passing `0` means no limit.
+Limit the amount of uploads going on at the same time. Setting this to `0` means there is no limit on concurrent uploads.
 
 
 [tus-js-client]: https://github.com/tus/tus-js-client
 [tus-js-client]: https://github.com/tus/tus-js-client