From 691c54e4bf424cf7a3639961f753cfff2d100370 Mon Sep 17 00:00:00 2001 From: Lloyd Brookes Date: Thu, 26 Nov 2015 21:12:49 +0000 Subject: [PATCH] docs --- README.md | 16 +++++++++++++++- jsdoc2md/README.hbs | 16 +++++++++++++++- 2 files changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c389359..2318173 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,21 @@ ***This is the documentation for the next version. For the previous release, see the `prev` branch. To install this prerelease: `$ npm i -g local-web-server@^1.0.0-beta`*** # local-web-server -A simple web-server for productive front-end development. +A simple web-server for productive front-end development. Typical use cases: + +* Front-end Development + * Static or Single Page App development + * reroute paths to local or remote resources + * Bundle with your front-end project + * Very little configuration, just a few options + * Outputs a dynamic statistics view to the terminal + * Configurable log output, compatible with [Goaccess, Logstalgia and glTail](https://github.com/75lb/local-web-server/blob/master/doc/visualisation.md) +* Back-end service mocking + * Prototype a web service, microservice, REST API etc. + * CORS-friendly, all origins allowed by default. +* Proxy server + * Useful to workaround CORS issues with remote servers +* File sharing **Requires node v4.0.0 or higher**. diff --git a/jsdoc2md/README.hbs b/jsdoc2md/README.hbs index e5a7c1c..f73e82e 100644 --- a/jsdoc2md/README.hbs +++ b/jsdoc2md/README.hbs @@ -7,7 +7,21 @@ ***This is the documentation for the next version. For the previous release, see the `prev` branch. To install this prerelease: `$ npm i -g local-web-server@^1.0.0-beta`*** # local-web-server -A simple web-server for productive front-end development. +A simple web-server for productive front-end development. Typical use cases: + +* Front-end Development + * Static or Single Page App development + * reroute paths to local or remote resources + * Bundle with your front-end project + * Very little configuration, just a few options + * Outputs a dynamic statistics view to the terminal + * Configurable log output, compatible with [Goaccess, Logstalgia and glTail](https://github.com/75lb/local-web-server/blob/master/doc/visualisation.md) +* Back-end service mocking + * Prototype a web service, microservice, REST API etc. + * CORS-friendly, all origins allowed by default. +* Proxy server + * Useful to workaround CORS issues with remote servers +* File sharing **Requires node v4.0.0 or higher**.