From f4abdbccaefa30d837e38f1c2c9b3513cf145f22 Mon Sep 17 00:00:00 2001 From: Lloyd Brookes Date: Wed, 28 Jun 2017 20:13:45 +0100 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ada0151..360a32e 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,22 @@ The modular web server for productive full-stack development. Use this tool to: -* Build a static website, dynamic website with server-side rendering, Single Page Application with client-side rendering, Progressive Web App etc. - any web application you like. -* Prototype a REST API, Microservice, websocket server or any other server-side application. +* Build a fast, modern web application using any tech, framework or architecture. +* Prototype back-end services (RESTful HTTP API, Microservice, websocket server etc.) + +Essentially, local-web-server is the `lws` command-line web server with a middleware stack built in offering the following features: + +* Static file serving +* Single Page Application support +* Response mocking +* Configurable access log +* URL Rewriting, to local or remote destinations +* Request body parsing +* Route blacklisting +* HTTP Conditional Request support (cacheing) +* MIME-type customisation +* Gzip response compression +* Directory listing support ## Synopsis @@ -27,6 +41,8 @@ Serving at http://mbp.local:8000, http://127.0.0.1:8000, http://192.168.0.100:80 Opening any of the listed URLs in your browser will open your home page (`index.html` by default) if one exists, else show a directory listing. + + ## Advanced Usage Being modular and extensible, features can be added or removed from `ws` in the shape of Middleware, ServerFactory or View modules. [See the wiki for full documentation and tutorials](https://github.com/lwsjs/local-web-server/wiki).