Improve all README's (#360)

Murderlon · web-flow · commit d0fef39deed8 · 2022-12-09T10:15:45.000-03:00
diff --git a/README.md b/README.md
@@ -97,30 +97,23 @@ fastify.listen(3000, (err) => {
 
 ## Packages
 
-- [`@tus/server`][]. The tus server. Standalone or integrate it into your Node.js server. Supports events and hooks for monitering and validation.
+- [`@tus/server`][]. The tus server. Standalone or integrate it into your Node.js server.
 - [`@tus/file-store`][]. Store files on disk.
 - [`@tus/s3-store`][]. Store files on AWS S3.
 - [`@tus/gcs-store`][]. Store files on Google Cloud Storage.
 
 ## Extensions
 
-The tus protocol supports optional [extensions][]:
+The tus protocol supports optional [extensions][]. Below is a table of the supported extensions.
 
-- [Creation][]. Create an upload.
-- [Creation With Upload][]. Include part of the upload in the initial request, rather than in subsequent `PATCH` request(s).
-- [Expiration][]. The Server MAY remove unfinished uploads once they expire.
-- [Checksum][]. Verify data integrity of each `PATCH` request.
-- [Termination][]. Allow clients to terminate (`DELETE`) completed and unfinished uploads allowing the Server to free up used resources.
-- [Concatenation][]. Concatenate multiple uploads into a single one enabling Clients to perform parallel uploads and to upload non-contiguous chunks
-
-| Extension            | [`file-store`][`@tus/file-store`] | [`s3-store`][`@tus/s3-store`] | [`gcs-store`][`@tus/gcs-store`] |
-| -------------------- | --------------------------------- | ----------------------------- | ------------------------------- |
-| Creation             | ✅                                | ✅                            | ✅                              |
-| Creation With Upload | ✅                                | ✅                            | ✅                              |
-| Expiration           | ✅                                | ❌                            | ❌                              |
-| Checksum             | ❌                                | ❌                            | ❌                              |
-| Termination          | ✅                                | ❌                            | ❌                              |
-| Concatenation        | ❌                                | ❌                            | ❌                              |
+| Extension                | [`file-store`][`@tus/file-store`] | [`s3-store`][`@tus/s3-store`] | [`gcs-store`][`@tus/gcs-store`] |
+| ------------------------ | --------------------------------- | ----------------------------- | ------------------------------- |
+| [Creation][]             | ✅                                | ✅                            | ✅                              |
+| [Creation With Upload][] | ✅                                | ✅                            | ✅                              |
+| [Expiration][]           | ✅                                | ❌                            | ❌                              |
+| [Checksum][]             | ❌                                | ❌                            | ❌                              |
+| [Termination][]          | ✅                                | ❌                            | ❌                              |
+| [Concatenation][]        | ❌                                | ❌                            | ❌                              |
 
 ## Demos
 
@@ -168,9 +161,9 @@ See [`contributing.md`](https://github.com/tus/tus-node-server/blob/main/.github
 [`@tus/s3-store`]: https://github.com/tus/tus-node-server/tree/main/packages/s3-store
 [`@tus/gcs-store`]: https://github.com/tus/tus-node-server/tree/main/packages/gcs-store
 [extensions]: https://tus.io/protocols/resumable-upload.html#protocol-extensions
-[Creation]: https://tus.io/protocols/resumable-upload.html#creation
-[Creation With Upload]: https://tus.io/protocols/resumable-upload.html#creation-with-upload
-[Expiration]: https://tus.io/protocols/resumable-upload.html#expiration
-[Checksum]: https://tus.io/protocols/resumable-upload.html#checksum
-[Termination]: https://tus.io/protocols/resumable-upload.html#termination
-[Concatenation]: https://tus.io/protocols/resumable-upload.html#concatenation
+[creation]: https://tus.io/protocols/resumable-upload.html#creation
+[creation with upload]: https://tus.io/protocols/resumable-upload.html#creation-with-upload
+[expiration]: https://tus.io/protocols/resumable-upload.html#expiration
+[checksum]: https://tus.io/protocols/resumable-upload.html#checksum
+[termination]: https://tus.io/protocols/resumable-upload.html#termination
+[concatenation]: https://tus.io/protocols/resumable-upload.html#concatenation
diff --git a/packages/file-store/README.md b/packages/file-store/README.md
@@ -10,6 +10,7 @@
 - [Use](#use)
 - [API](#api)
   - [`new FileStore(options)`](#new-filestoreoptions)
+- [Extensions](#extensions)
 - [Examples](#examples)
   - [Example: creating your own config store](#example-creating-your-own-config-store)
 - [Types](#types)
@@ -46,13 +47,35 @@ This package exports `FileStore`. There is no default export.
 
 Creates a new file store with options.
 
-#### `directory`
+#### `options.directory`
 
-The directory to store the files on disk.
+The directory to store the files on disk (`string`).
 
-#### `configstore`
+#### `options.configstore`
 
-Provide your own storage solution for the metadata of uploads. Default uses [`configstore`](https://www.npmjs.com/package/configstore).
+Provide your own storage solution for the metadata of uploads (`Class`).
+
+Default uses [`configstore`](https://www.npmjs.com/package/configstore).
+
+#### `options.expirationPeriodInMilliseconds`
+
+The time before an _ongoing_ upload is considered expired (`number`).
+
+This is since the time of creation, not modification. Once an upload is considered expired,
+uploads can be removed with [`cleanUpExpiredUploads`](https://github.com/tus/tus-node-server/tree/main/packages/server#)#servercleanupexpireduploads
+
+## Extensions
+
+The tus protocol supports optional [extensions][]. Below is a table of the supported extensions in `@tus/file-store`.
+
+| Extension                | `@tus/file-store` |
+| ------------------------ | ----------------- |
+| [Creation][]             | ✅                |
+| [Creation With Upload][] | ✅                |
+| [Expiration][]           | ✅                |
+| [Checksum][]             | ❌                |
+| [Termination][]          | ✅                |
+| [Concatenation][]        | ❌                |
 
 ## Examples
 
@@ -108,3 +131,11 @@ See [`contributing.md`](https://github.com/tus/tus-node-server/blob/main/.github
 ## License
 
 [MIT](https://github.com/tus/tus-node-server/blob/master/license) © [tus](https://github.com/tus)
+
+[extensions]: https://tus.io/protocols/resumable-upload.html#protocol-extensions
+[creation]: https://tus.io/protocols/resumable-upload.html#creation
+[creation with upload]: https://tus.io/protocols/resumable-upload.html#creation-with-upload
+[expiration]: https://tus.io/protocols/resumable-upload.html#expiration
+[checksum]: https://tus.io/protocols/resumable-upload.html#checksum
+[termination]: https://tus.io/protocols/resumable-upload.html#termination
+[concatenation]: https://tus.io/protocols/resumable-upload.html#concatenation
diff --git a/packages/gcs-store/README.md b/packages/gcs-store/README.md
@@ -48,18 +48,31 @@ This package exports `GCSStore`. There is no default export.
 
 Creates a new Google Cloud Storage store with options.
 
-#### `projectId`
+#### `options.projectId`
 
 The GCS project ID (`string`).
 
-#### `keyFilename`
+#### `options.keyFilename`
 
 Path to the keyfile with credentials (`string`).
 
-#### `bucket`
+#### `options.bucket`
 
 The bucket name.
 
+## Extensions
+
+The tus protocol supports optional [extensions][]. Below is a table of the supported extensions in `@tus/gcs-store`.
+
+| Extension                | `@tus/gcs-store` |
+| ------------------------ | ---------------- |
+| [Creation][]             | ✅               |
+| [Creation With Upload][] | ✅               |
+| [Expiration][]           | ❌               |
+| [Checksum][]             | ❌               |
+| [Termination][]          | ❌               |
+| [Concatenation][]        | ❌               |
+
 ## Types
 
 This package is fully typed with TypeScript.
@@ -75,3 +88,11 @@ See [`contributing.md`](https://github.com/tus/tus-node-server/blob/main/.github
 ## License
 
 [MIT](https://github.com/tus/tus-node-server/blob/master/license) © [tus](https://github.com/tus)
+
+[extensions]: https://tus.io/protocols/resumable-upload.html#protocol-extensions
+[creation]: https://tus.io/protocols/resumable-upload.html#creation
+[creation with upload]: https://tus.io/protocols/resumable-upload.html#creation-with-upload
+[expiration]: https://tus.io/protocols/resumable-upload.html#expiration
+[checksum]: https://tus.io/protocols/resumable-upload.html#checksum
+[termination]: https://tus.io/protocols/resumable-upload.html#termination
+[concatenation]: https://tus.io/protocols/resumable-upload.html#concatenation
diff --git a/packages/s3-store/README.md b/packages/s3-store/README.md
@@ -10,6 +10,7 @@
 - [Use](#use)
 - [API](#api)
   - [`new S3Store(options)`](#new-s3storeoptions)
+- [Extensions](#extensions)
 - [Examples](#examples)
   - [Example: using `credentials` to fetch credentials inside a AWS container](#example-using-credentials-to-fetch-credentials-inside-a-aws-container)
 - [Types](#types)
@@ -56,16 +57,29 @@ Creates a new AWS S3 store with options.
 > All options except for `bucket` and `partSize` are directly passed to the S3 client.
 > This means you can also provide alternative authentication properties, such as [credentials](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/Credentials.html#constructor-property).
 
-#### `bucket`
+#### `options.bucket`
 
 The bucket name.
 
-#### `partSize`
+#### `options.partSize`
 
 The preferred part size for parts send to S3. Can not be lower than 5MB or more than 500MB.
 The server calculates the optimal part size, which takes this size into account,
 but may increase it to not exceed the S3 10K parts limit.
 
+## Extensions
+
+The tus protocol supports optional [extensions][]. Below is a table of the supported extensions in `@tus/s3-store`.
+
+| Extension                | `@tus/s3-store` |
+| ------------------------ | --------------- |
+| [Creation][]             | ✅              |
+| [Creation With Upload][] | ✅              |
+| [Expiration][]           | ❌              |
+| [Checksum][]             | ❌              |
+| [Termination][]          | ❌              |
+| [Concatenation][]        | ❌              |
+
 ## Examples
 
 ### Example: using `credentials` to fetch credentials inside a AWS container
@@ -108,3 +122,11 @@ See [`contributing.md`](https://github.com/tus/tus-node-server/blob/main/.github
 ## License
 
 [MIT](https://github.com/tus/tus-node-server/blob/master/license) © [tus](https://github.com/tus)
+
+[extensions]: https://tus.io/protocols/resumable-upload.html#protocol-extensions
+[creation]: https://tus.io/protocols/resumable-upload.html#creation
+[creation with upload]: https://tus.io/protocols/resumable-upload.html#creation-with-upload
+[expiration]: https://tus.io/protocols/resumable-upload.html#expiration
+[checksum]: https://tus.io/protocols/resumable-upload.html#checksum
+[termination]: https://tus.io/protocols/resumable-upload.html#termination
+[concatenation]: https://tus.io/protocols/resumable-upload.html#concatenation
diff --git a/packages/server/README.md b/packages/server/README.md
