tlsd 2.2.0 → 2.2.2

package/README.md

@@ -1,17 +1,56 @@
 
 # tlsd
 
-## Install
 
-    npm install tlsd
+There are 2 ways to use this:
 
+  1. Install globally as CLI command "tlsd"
+  2. Install locally to an existing project directory and executed with "npx tlsd"
 
-### Dev Mode
 
-In dev mode it runs a plain HTTP server without any of the certificate
-stuff:
+## Install Globally
 
-    node tlsd.js root_dir port_num log_level
+    npm install -g tlsd
+
+You should how have a CLI command "tlsd"
+
+	tlsd
+
+This way lets you run a project without having to have tlsd included in it.
+
+
+## Install Locally
+
+	npm install --save tlsd
+
+The tlsd module should now be added to your local package.json file and you can
+run it this way:
+
+	npx tlsd
+
+This way you can just use it to serve your local project in dev or production mode.
+
+
+## tlsd init
+
+Creates empty scaffolding files for a project:
+
+	tlsd init my_project
+
+This can then be tested by starting the server:
+
+	tlsd run dev my_project 12345 3
+
+And then browsing to "http://localhost:12345".
+You should see the pages being delivered and a websocket connecting being established.
+
+
+## tlsd run dev
+
+In dev mode, tlsd runs a plain HTTP server without TLS/SSL security.
+This is for local (your computer) development:
+
+    tlsd root_dir port_num log_level
 
 All arguments are required
 
@@ -30,5 +69,7 @@ You must also add your domain to greenlock before running nodes or it won't be r
 
 	npx greenlock add --subject example.com --altnames example.com,www.example.com
 
+Production mode serves files with Letsencrypt SSL certs magically.
+
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tlsd",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "description": "An server for web app prototyping with HTTPS and Websockets",
   "main": "tlsd.js",
   "bin": {

package/tlsd

@@ -96,6 +96,12 @@ if [ "$cmd" = "init" ] ; then
 fi
 
 
-echo "Usage: tlsd init|run ..."
+if [ "$cmd" = "version" ] || [ "$cmd" = "-v" ] ; then
+	node "$home/tlsd.js" -v
+	exit 0;
+fi
+
+
+echo "Usage: tlsd init|run|version ..."
 exit 1
 

package/tlsd.js

@@ -361,6 +361,15 @@ if( argv.length == 5 ) {
 		usage();
 	}
 
+}
+else
+if( argv.length == 3 && argv[ 2 ] == "-v" ) {
+
+	// pull package version from package.json and print it
+
+	const p = require( __dirname + "/package.json" );
+	log( p.version );
+
 }
 else {
 	usage();