From a04a8be532f2df20c4d77dc4fc4863b8d412ed45 Mon Sep 17 00:00:00 2001 From: Lloyd Brookes Date: Fri, 20 Nov 2015 09:52:51 +0000 Subject: [PATCH] docs --- README.md | 6 ++++-- jsdoc2md/README.hbs | 2 ++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c854723..ce07e19 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ [![Dependency Status](https://david-dm.org/75lb/local-web-server.svg)](https://david-dm.org/75lb/local-web-server) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard) +***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. @@ -233,10 +235,10 @@ Returns a Koa application you can launch or mix into an existing app. **Params** - [options] object - options - [.static] object - koa-static config - - [.root] string - root directory + - [.root] string = "." - root directory - [.options] string - [options](https://github.com/koajs/static#options) - [.serveIndex] object - koa-serve-index config - - [.path] string - root directory + - [.path] string = "." - root directory - [.options] string - [options](https://github.com/expressjs/serve-index#options) - [.forbid] Array.<string> - A list of forbidden routes, each route being an [express route-path](http://expressjs.com/guide/routing.html#route-paths). - [.spa] string - specify an SPA file to catch requests for everything but static assets. diff --git a/jsdoc2md/README.hbs b/jsdoc2md/README.hbs index 846871e..1c66e8d 100644 --- a/jsdoc2md/README.hbs +++ b/jsdoc2md/README.hbs @@ -4,6 +4,8 @@ [![Dependency Status](https://david-dm.org/75lb/local-web-server.svg)](https://david-dm.org/75lb/local-web-server) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard) +***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.