Browse Source

update docs

master
Lloyd Brookes 9 years ago
parent
commit
4ddfdf2843
  1. 2
      LICENSE
  2. 6
      README.md
  3. 5
      jsdoc2md/README.hbs

2
LICENSE

@ -1,6 +1,6 @@
The MIT License (MIT) 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 Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

6
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. 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 ### Stored config
Use the same options every time? Persist then to `package.json`: Use the same options every time? Persist then to `package.json`:
@ -591,6 +594,7 @@ Returns a Koa application you can launch or mix into an existing app.
**Kind**: Exported function **Kind**: Exported function
**Params** **Params**
- [options] <code>object</code> - options - [options] <code>object</code> - options
- [.static] <code>object</code> - koa-static config - [.static] <code>object</code> - koa-static config
- [.root] <code>string</code> <code> = &quot;.&quot;</code> - root directory - [.root] <code>string</code> <code> = &quot;.&quot;</code> - root directory
@ -638,4 +642,4 @@ The `from` and `to` routes are specified using [express route-paths](http://expr
* * * * * *
&copy; 2015 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
&copy; 2013-16 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).

5
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. 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 ### Stored config
Use the same options every time? Persist then to `package.json`: Use the same options every time? Persist then to `package.json`:
@ -589,4 +592,4 @@ serving at http://localhost:8100
* * * * * *
&copy; 2015 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
&copy; 2013-16 Lloyd Brookes <75pound@gmail.com>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
Loading…
Cancel
Save