From 8bdc098f0bd53ca2f5fe98fa90d61b3f68273f96 Mon Sep 17 00:00:00 2001 From: Sven-Hendrik Haase Date: Sun, 28 Mar 2021 22:54:46 +0200 Subject: Update README --- README.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 9e1eb7e..714f260 100644 --- a/README.md +++ b/README.md @@ -140,6 +140,9 @@ Sometimes this is just a more practical and quick way than doing things properly -p, --port Port to use [default: 8080] + --print-completions + Generate completion file for a shell [possible values: zsh, bash, fish, + powershell, elvish] -t, --title Shown instead of host in page title and heading -- cgit v1.2.3 From d7d985037f19263abd5b5861757cc94fee1989ad Mon Sep 17 00:00:00 2001 From: Sven-Hendrik Haase <svenstaro@gmail.com> Date: Sun, 28 Mar 2021 23:14:41 +0200 Subject: Update features list --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 714f260..9796886 100644 --- a/README.md +++ b/README.md @@ -67,8 +67,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 on the fly as `.tar.gz` or `.zip`) - File uploading -- Pretty themes +- Pretty themes (with light and dark theme support) - Scan QR code for quick access +- Shell completions +- Sane and secure defaults ## Usage -- cgit v1.2.3 From b0a84c74ddbd50f760a002e470cfdb815a1bdd1a Mon Sep 17 00:00:00 2001 From: Sven-Hendrik Haase <svenstaro@gmail.com> Date: Sun, 28 Mar 2021 23:15:23 +0200 Subject: Add README instructions for using shell completions --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 9796886..5503f4d 100644 --- a/README.md +++ b/README.md @@ -189,6 +189,19 @@ Alternatively install with [Homebrew](https://brew.sh/). docker run -v /tmp:/tmp -p 8080:8080 --rm -it svenstaro/miniserve /tmp +## Shell completions + +If you'd like to make use of the built-in shell completion support, you need to run `miniserve +--print-completions <your-shell>` and put the completions in the correct place for your shell. A +few examples with common paths are provided below: + + # For bash + miniserve --print-completions bash > ~/.local/share/bash-completion/miniserve + # For zsh + miniserve --print-completions zsh > /usr/local/share/zsh/site-functions/_miniserve + # For fish + miniserve --print-completions fish > ~/.config/fish/completions/miniserve.fish + ## Binding behavior For convenience reasons, miniserve will try to bind on all interfaces by default (if no `-i` is provided). -- cgit v1.2.3 From ae54ca44f52651e5931641aba1a5074218905c96 Mon Sep 17 00:00:00 2001 From: Sven-Hendrik Haase <svenstaro@gmail.com> Date: Sun, 28 Mar 2021 23:16:22 +0200 Subject: (cargo-release) version 0.13.0 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5503f4d..0ad41a0 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ Sometimes this is just a more practical and quick way than doing things properly ## Usage - miniserve 0.12.1 + miniserve 0.13.0 Sven-Hendrik Haase <svenstaro@gmail.com>, Boastful Squirrel <boastful.squirrel@gmail.com> For when you really just want to serve some files over HTTP right now! -- cgit v1.2.3 From 755983d3d7985833fb4fb1b4510b9c677771dd79 Mon Sep 17 00:00:00 2001 From: Sven-Hendrik Haase <svenstaro@gmail.com> Date: Sun, 18 Apr 2021 05:43:58 +0200 Subject: Update README for separate .tar and .tar.gz flags --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 0ad41a0..6aa1782 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,10 @@ Sometimes this is just a more practical and quick way than doing things properly List directories first -r, --enable-tar - Enable tar archive generation + Enable uncompressed tar archive generation + + -g, --enable-tar-gz + Enable gz-compressed tar archive generation -z, --enable-zip Enable zip archive generation -- cgit v1.2.3