From 4ddfdf2843633082eeb61bbfdfe1a9ce5698cf86 Mon Sep 17 00:00:00 2001 From: Lloyd Brookes Date: Thu, 10 Mar 2016 10:58:52 +0000 Subject: [PATCH] update docs --- LICENSE | 2 +- README.md | 40 ++++++++++++++++++++++------------------ jsdoc2md/README.hbs | 5 ++++- 3 files changed, 27 insertions(+), 20 deletions(-) diff --git a/LICENSE b/LICENSE index 2abca62..677f7e8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2015 Lloyd Brookes <75pound@gmail.com> +Copyright (c) 2013-16 Lloyd Brookes <75pound@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index d9a98ed..0b3c244 100644 --- a/README.md +++ b/README.md @@ -444,6 +444,9 @@ Chrome and Firefox will still complain your certificate has not been verified by Now you have a valid, trusted certificate for development. +#### Built-in certificate +As a quick win, you can run `ws` with the `https` flag. This will launch an HTTPS server using a [built-in certificate](https://github.com/75lb/local-web-server/tree/master/ssl) registered to the domain 127.0.0.1. + ### Stored config Use the same options every time? Persist then to `package.json`: @@ -582,8 +585,8 @@ serving at http://localhost:8100 * [local-web-server](#module_local-web-server) - * [localWebServer([options])](#exp_module_local-web-server--localWebServer) ⇒ [KoaApplication](https://github.com/koajs/koa/blob/master/docs/api/index.md#application) ⏏ - * [~rewriteRule](#module_local-web-server--localWebServer..rewriteRule) + * [localWebServer([options])](#exp_module_local-web-server--localWebServer) ⇒ [KoaApplication](https://github.com/koajs/koa/blob/master/docs/api/index.md#application) ⏏ + * [~rewriteRule](#module_local-web-server--localWebServer..rewriteRule) ### localWebServer([options]) ⇒ [KoaApplication](https://github.com/koajs/koa/blob/master/docs/api/index.md#application) ⏏ @@ -591,22 +594,23 @@ Returns a Koa application you can launch or mix into an existing app. **Kind**: Exported function **Params** + - [options] object - options - - [.static] object - koa-static config - - [.root] string = "." - root directory - - [.options] string - [options](https://github.com/koajs/static#options) - - [.serveIndex] object - koa-serve-index config - - [.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. - - [.log] object - [morgan](https://github.com/expressjs/morgan) config - - [.format] string - [log format](https://github.com/expressjs/morgan#predefined-formats) - - [.options] object - [options](https://github.com/expressjs/morgan#options) - - [.compress] boolean - Serve gzip-compressed resources, where applicable - - [.mime] object - A list of mime-type overrides, passed directly to [mime.define()](https://github.com/broofa/node-mime#mimedefine) - - [.rewrite] [Array.<rewriteRule>](#module_local-web-server--localWebServer..rewriteRule) - One or more rewrite rules - - [.verbose] boolean - Print detailed output, useful for debugging + - [.static] object - koa-static config + - [.root] string = "." - root directory + - [.options] string - [options](https://github.com/koajs/static#options) + - [.serveIndex] object - koa-serve-index config + - [.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. + - [.log] object - [morgan](https://github.com/expressjs/morgan) config + - [.format] string - [log format](https://github.com/expressjs/morgan#predefined-formats) + - [.options] object - [options](https://github.com/expressjs/morgan#options) + - [.compress] boolean - Serve gzip-compressed resources, where applicable + - [.mime] object - A list of mime-type overrides, passed directly to [mime.define()](https://github.com/broofa/node-mime#mimedefine) + - [.rewrite] [Array.<rewriteRule>](#module_local-web-server--localWebServer..rewriteRule) - One or more rewrite rules + - [.verbose] boolean - Print detailed output, useful for debugging **Example** ```js @@ -638,4 +642,4 @@ The `from` and `to` routes are specified using [express route-paths](http://expr * * * -© 2015 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown). +© 2013-16 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown). diff --git a/jsdoc2md/README.hbs b/jsdoc2md/README.hbs index eec3e98..0c64189 100644 --- a/jsdoc2md/README.hbs +++ b/jsdoc2md/README.hbs @@ -444,6 +444,9 @@ Chrome and Firefox will still complain your certificate has not been verified by Now you have a valid, trusted certificate for development. +#### Built-in certificate +As a quick win, you can run `ws` with the `https` flag. This will launch an HTTPS server using a [built-in certificate](https://github.com/75lb/local-web-server/tree/master/ssl) registered to the domain 127.0.0.1. + ### Stored config Use the same options every time? Persist then to `package.json`: @@ -589,4 +592,4 @@ serving at http://localhost:8100 * * * -© 2015 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown). +© 2013-16 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).