aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorboasting-squirrel <boasting.squirrel@gmail.com>2019-03-19 20:00:14 +0000
committerboasting-squirrel <boasting.squirrel@gmail.com>2019-03-19 20:00:14 +0000
commit20b7c82599ae23638bb9a79e3b7aafa1f7a42232 (patch)
treeb5ebbb5a4c80f9736484f9cd9112ef30956e4178
parentFixed comments (diff)
downloadminiserve-20b7c82599ae23638bb9a79e3b7aafa1f7a42232.tar.gz
miniserve-20b7c82599ae23638bb9a79e3b7aafa1f7a42232.zip
Updated README with known limitations
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index c2a85e4..2b8e8b3 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,10 @@ Sometimes this is just a more practical and quick way than doing things properly
- Mega fast and highly parallel (thanks to [Rust](https://www.rust-lang.org/) and [Actix](https://actix.rs/))
- Folder download (compressed in .tar.gz)
+## Known limitations
+
+- **For now**, the tar.gz compression is not async-ready, which means that the whole archive needs to be created (in memory) before the download starts. While it should not be a problem for small folders, the download feature can really get resource-heavy for large folders.
+
## How to install
**On Linux**: Download `miniserve-linux` from [the releases page](https://github.com/svenstaro/miniserve/releases) and run