aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSven-Hendrik Haase <svenstaro@gmail.com>2022-10-14 12:18:19 +0000
committerSven-Hendrik Haase <svenstaro@gmail.com>2022-10-14 12:18:19 +0000
commit5f5ccce2c8411d8222ea01762cfa188e9c496f4a (patch)
treeef2aebd86e4216b6e4dd6664818efb02360ba074 /README.md
parentFix clap deprecations (diff)
downloadminiserve-5f5ccce2c8411d8222ea01762cfa188e9c496f4a.tar.gz
miniserve-5f5ccce2c8411d8222ea01762cfa188e9c496f4a.zip
Try to reflow README to fit better
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/README.md b/README.md
index ae626a0..627f53f 100644
--- a/README.md
+++ b/README.md
@@ -127,14 +127,16 @@ Some mobile browsers like Firefox on Android will offer to open the camera app w
--index <INDEX>
The name of a directory index file to serve, like "index.html"
- Normally, when miniserve serves a directory, it creates a listing for that directory. However, if a directory contains this
- file, miniserve will serve that file instead.
+ Normally, when miniserve serves a directory, it creates a listing for that
+ directory. However, if a directory contains this file, miniserve will serve that
+ file instead.
--spa
Activate SPA (Single Page Application) mode
- This will cause the file given by --index to be served for all non-existing file paths. In effect, this will serve the index
- file whenever a 404 would otherwise occur in order to allow the SPA router to handle the request instead.
+ This will cause the file given by --index to be served for all non-existing file
+ paths. In effect, this will serve the index file whenever a 404 would otherwise
+ occur in order to allow the SPA router to handle the request instead.
-p, --port <PORT>
Port to use
@@ -145,7 +147,8 @@ Some mobile browsers like Firefox on Android will offer to open the camera app w
Interface to listen on
-a, --auth <AUTH>...
- Set authentication. Currently supported formats: username:password, username:sha256:hash, username:sha512:hash (e.g. joe:123,
+ Set authentication. Currently supported formats: username:password,
+ username:sha256:hash, username:sha512:hash (e.g. joe:123,
joe:sha256:a665a45920422f9d417e4867efdc4fb8a04a1f3fff1fa07e998e86f7f7a27ae3)
--route-prefix <ROUTE_PREFIX>
@@ -201,8 +204,8 @@ Some mobile browsers like Firefox on Android will offer to open the camera app w
-z, --enable-zip
Enable zip archive generation
- WARNING: Zipping large directories can result in out-of-memory exception because zip generation is done in memory and cannot
- be sent on the fly
+ WARNING: Zipping large directories can result in out-of-memory exception because zip
+ generation is done in memory and cannot be sent on the fly
-D, --dirs-first
List directories first