chore: Add link to chunk size docs in README

okumy · Mar 19, 2020 · 31ff4b6 · 31ff4b6
1 parent 261a4dc
commit 31ff4b6
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -56,3 +56,11 @@ directory.
         upload_url="/uploads",
         upload_path=Path(__file__).parent.parent / "uploads",
     )
+
+Chunk Size
+==========
+
+Please, make sure to configure ``client_max_size`` for ``aiohttp.web`` Application and
+supply proper ``chunkSize`` for Uppy.io or other tus.io client.
+
+`Documentation <https://aiohttp-tus.readthedocs.io/en/latest/usage.html#understanding-tus-io-chunk-size>`_
diff --git a/pyproject.toml b/pyproject.toml
@@ -21,6 +21,7 @@ authors = ["Igor Davydenko <iam@igordavydenko.com>"]
 license = "BSD-3-Clause"
 readme = "README.rst"
 repository = "https://github.com/pylotcode/aiohttp-tus"
+documentation = "https://aiohttp-tus.readthedocs.io/"
 keywords = ["aiohttp", "tus", "tus.io"]
 classifiers = [
     "Development Status :: 4 - Beta",