From bfb7e9f345e4033a895f28183a4ff2af4ba8f501 Mon Sep 17 00:00:00 2001 From: boasting-squirrel Date: Sat, 9 Mar 2019 18:03:29 +0100 Subject: Updated README --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 73dba75..cc8d30f 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,7 @@ Sometimes this is just a more practical and quick way than doing things properly - Single binary drop-in with no extra dependencies required - Authentication support with username and password - Mega fast and highly parallel (thanks to [Rust](https://www.rust-lang.org/) and [Actix](https://actix.rs/)) +- Folder download (compressed in .tar.gz) ## How to install -- cgit v1.2.3 From 20b7c82599ae23638bb9a79e3b7aafa1f7a42232 Mon Sep 17 00:00:00 2001 From: boasting-squirrel Date: Tue, 19 Mar 2019 21:00:14 +0100 Subject: Updated README with known limitations --- README.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'README.md') 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 -- cgit v1.2.3