lws - npm Package Compare versions

Comparing version 2.0.0-11 to 2.0.0

index.js

@@ -30,2 +30,7 @@ const util = require('./lib/util')
 /**
+ * @external LwsConfig
+ * @see https://github.com/lwsjs/lws/blob/master/doc/config.md
+ */
+
+/**
  * @alias module:lws
@@ -37,3 +42,3 @@ * @emits verbose
    * Contructs an empty `Lws` instance but does not initialise it. Use the `Lws.create(config)` factory method to create, initialise and launch a lws server.
-   * @param {LwsConfig} - Server config.
+   * @param {external:LwsConfig} - Server config.
    */
@@ -56,3 +61,3 @@ constructor (config) {
      * The active lws config.
-     * @type {LwsConfig}
+     * @type {external:LwsConfig}
      */
@@ -79,4 +84,3 @@ this.config = null
    * Merge supplied config with defaults and stored config.
-   * @param {object}
-   * @returns {object}
+   * @param {external:LwsConfig}
    * @ignore
@@ -276,3 +280,3 @@ */
    * Launch a listening HTTP, HTTPS or HTTP2 server configured as specified by the supplied config.
-   * @param config {LwsConfig}
+   * @param config {external:LwsConfig}
    * @returns {Lws}
@@ -279,0 +283,0 @@ */

lib/config.js

@@ -7,2 +7,7 @@ /**
 /**
+ * @external MiddlewarePlugin
+ * @see https://github.com/lwsjs/lws/blob/master/doc/middleware-plugin.md
+ */
+
+/**
  * @alias module:lws-config
@@ -93,3 +98,3 @@ */
      * Array of middleware classes, or filenames of modules exporting a middleware class.
-     * @type {string[]|MiddlewarePlugin[]}
+     * @type {string[]|external:MiddlewarePlugin[]}
      */
@@ -96,0 +101,0 @@ this.stack = null

package.json

 {
   "name": "lws",
   "author": "Lloyd Brookes <[e-mail]>",
-  "version": "2.0.0-11",
+  "version": "2.0.0",
   "description": "A modular HTTP, HTTPS and HTTP2 command-line web server for personalised, full-stack web development",
@@ -6,0 +6,0 @@ "repository": "https://github.com/lwsjs/lws.git",

README.md

@@ -10,14 +10,9 @@ [![view on npm](https://img.shields.io/npm/v/lws.svg)](https://www.npmjs.org/package/lws)
 
-***This documentation is a work in progress.***
+A lean, modular web server for rapid full-stack development.
 
-A modular HTTP, HTTPS and HTTP2 command-line web server for personalised, full-stack web development.
+Lws is an application core for quickly launching a local web server. Behaviour is added via plugins giving you full control over how requests are processed and responses created.
 
-Its has a very lean core - behaviour is added via plugins giving you full control over what features are activated, how HTTP requests are handled, responses created, caches controlled, activity visualised etc.
-
-Core features.
-
-* Launch an HTTP, HTTPS or HTTP2 server.
-* Use one or more custom or pre-built middleware plugins to attach the behaviour required by your project.
+* Supports HTTP, HTTPS and HTTP2.
+* Small and 100% personalisable. Load and use only the behaviour required by your project.
 * Attach a custom view to personalise how activity is visualised.
-* Store config at any level - project, user or system.
 * Programmatic and command-line APIs.
@@ -45,3 +40,3 @@
 
-Install and use some middleware to serve static files and directory listings.
+Install and use some middleware ([lws-static](https://github.com/lwsjs/static) and [lws-index](https://github.com/lwsjs/index)) to serve static files and directory listings.
 
@@ -96,3 +91,2 @@ ```
 
-* [Tutorials](https://github.com/lwsjs/lws/wiki)
 * API Reference
@@ -103,4 +97,9 @@ * [Lws](https://github.com/lwsjs/lws/blob/master/doc/lws.md)
 
+## See also
+
+* [lws plugin list](https://npms.io/search?q=keywords%3Alws-middleware). 
+* [local-web-server](https://github.com/lwsjs/local-web-server), an lws distribution with the most common plugins already installed.
+
 * * *
 
 &copy; 2016-19 Lloyd Brookes \<[e-mail]\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

96461

increased by0.29%

Lines of code

1068

increased by0.66%

Number of low quality alerts

1

decreased by-50%

Worsened metrics

Number of lines in readme file

102

decreased by-0.97%

No dependency changes