From f88766e4602222011eff5b5036100621286628c3 Mon Sep 17 00:00:00 2001 From: Lloyd Brookes Date: Tue, 17 Nov 2015 14:06:45 +0000 Subject: [PATCH] docs --- README.md | 14 +++++++------- jsdoc2md/README.hbs | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index a80f509..b6b5a8f 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ A simple web-server for productive front-end development. **Requires node v4.0.0 or higher**. ## Synopsis -For the examples below, assume we're in a project directory looking like this: +For the examples below, and we assume we're in a project directory looking like this: ```sh . @@ -20,6 +20,8 @@ For the examples below, assume we're in a project directory looking like this: └── package.json ``` +All paths/routes are specified using [express syntax](http://expressjs.com/guide/routing.html#route-paths). + ### Static site Fire up your static site on the default port: @@ -47,8 +49,6 @@ $ ws --forbid '*.json' '*.yml' serving at http://localhost:8000 ``` -[Path syntax](http://expressjs.com/guide/routing.html#route-paths) - ### URL rewriting Your application requested `/css/style.css` but it's stored at `/build/css/style.css`. To avoid a 404 you need a rewrite rule: @@ -137,7 +137,7 @@ $ ws --compress #### Disable caching -Disable etag-based caching +Disable etag response headers, forcing resources to be served in full every time. ```sh $ ws --no-cache ``` @@ -147,9 +147,9 @@ You can set additional mime-type/extension mappings, or override the defaults by ```json { - "mime": { - "text/plain": [ "php", "pl" ] - } + "mime": { + "text/plain": [ "php", "pl" ] + } } ``` diff --git a/jsdoc2md/README.hbs b/jsdoc2md/README.hbs index 951250a..c08da76 100644 --- a/jsdoc2md/README.hbs +++ b/jsdoc2md/README.hbs @@ -10,7 +10,7 @@ A simple web-server for productive front-end development. **Requires node v4.0.0 or higher**. ## Synopsis -For the examples below, assume we're in a project directory looking like this: +For the examples below, and we assume we're in a project directory looking like this: ```sh . @@ -20,6 +20,8 @@ For the examples below, assume we're in a project directory looking like this: └── package.json ``` +All paths/routes are specified using [express syntax](http://expressjs.com/guide/routing.html#route-paths). + ### Static site Fire up your static site on the default port: @@ -47,8 +49,6 @@ $ ws --forbid '*.json' '*.yml' serving at http://localhost:8000 ``` -[Path syntax](http://expressjs.com/guide/routing.html#route-paths) - ### URL rewriting Your application requested `/css/style.css` but it's stored at `/build/css/style.css`. To avoid a 404 you need a rewrite rule: @@ -137,7 +137,7 @@ $ ws --compress #### Disable caching -Disable etag-based caching +Disable etag response headers, forcing resources to be served in full every time. ```sh $ ws --no-cache ``` @@ -147,9 +147,9 @@ You can set additional mime-type/extension mappings, or override the defaults by ```json { - "mime": { - "text/plain": [ "php", "pl" ] - } + "mime": { + "text/plain": [ "php", "pl" ] + } } ```