From 0b8ed4dd514071d8f62d4810aaba270f236f1f65 Mon Sep 17 00:00:00 2001 From: Jose Quintana Date: Fri, 29 Nov 2019 15:03:17 +0100 Subject: [PATCH] docs: add features to readme file --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 76a5552..5dfc09a 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,19 @@ > A blazing fast static files-serving web server powered by [Rust Iron](https://github.com/iron/iron). :zap: -**Static Web Server** is a small (`1.4M` static binary) and fast web server to serving static files like html files or assets. - -It's also an option to deploy it inside a [Docker container](https://hub.docker.com/r/joseluisq/static-web-server). +**Static Web Server** is a very small and fast web server to serving static files such as html files or assets. + +## Features + +- Built with [Rust](https://rust-lang.org) which is focused on [safety, speed, and concurrency](https://kornel.ski/rust-c-speed). +- Memory safety and reduced overhead of CPU and RAM resources. +- Blazing fast static files-serving thanks to [Rust Iron](https://github.com/iron/iron). +- Suitable for small [GNU/Linux Docker containers](https://hub.docker.com/r/joseluisq/static-web-server). It's a fully __1.4MB__ static binary thanks to [Rust and Musl libc](https://doc.rust-lang.org/edition-guide/rust-2018/platform-and-target-support/musl-support-for-fully-static-binaries.html). +- Gzip compression by default. +- Cache control headers included. +- Configurable via environment variables. +- Lightweight logging support. +- Scratch and [latest Alpine Linux](https://hub.docker.com/_/alpine) Docker images available. ## Usage -- libgit2 1.7.2