aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSven-Hendrik Haase <svenstaro@gmail.com>2019-03-23 12:49:46 +0000
committerGitHub <noreply@github.com>2019-03-23 12:49:46 +0000
commitc47a7773228e4e1beddfdcc6719cbc10acfbfdb5 (patch)
treeb5ebbb5a4c80f9736484f9cd9112ef30956e4178 /README.md
parentMerge pull request #49 from svenstaro/dependabot/cargo/structopt-0.2.15 (diff)
parentUpdated README with known limitations (diff)
downloadminiserve-c47a7773228e4e1beddfdcc6719cbc10acfbfdb5.tar.gz
miniserve-c47a7773228e4e1beddfdcc6719cbc10acfbfdb5.zip
Merge pull request #48 from boastful-squirrel/targz
Download folders in .tar.gz format
Diffstat (limited to '')
-rw-r--r--README.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.md b/README.md
index c30007c..2b8e8b3 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,11 @@ 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)
+
+## 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