refactor: finish moving ssh-* scripts to own installers

[webi-installers/.git] / node / README.md

diff --git a/node/README.md b/node/README.md
index 7a8e6d0cb7c300cdd3eaabdf805489d29cef3a10..bfbd5b32ed77593b78f0c48be4e3a2e458ad336a 100644 (file)
--- a/node/README.md
+++ b/node/README.md
@@ -3,18 +3,36 @@ title: Node.js
 homepage: https://nodejs.org
 tagline: |
   Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.
-description: |
-  Node is great for simple, snappy HTTP(S) servers, and for stitching APIs together with minimal fuss or muss.
 ---
 
-Hello World
+To update or switch versions, run `webi node@<tag>`. \
+(you can use `@lts` for long-term support, `@beta` for pre-releases, or `@x.y.z`
+for a specific version)
+
+## Cheat Sheet
+
+> Node is great for simple, snappy HTTP(S) servers, and for stitching APIs
+> together with minimal fuss or muss.
+
+Installing node via webi will:
+
+- pick a compatible version from the
+  [Node Releases API](https://nodejs.org/dist/index.tab)
+- download and unpack to `$HOME/.local/opt/node/`
+- update your `PATH` in `$HOME/.config/envman/PATH.env`
+- run `npm config set scripts-prepend-node-path=true`
+  - (prevents conflicts with other installed node versions)
+- absolutely leave system file permissions alone
+  - (no dreaded `sudo npm` permission errors)
+
+### Hello World
 
 ```bash
 node -e 'console.log("Hello, World!")'
 > Hello, World!
 ```
 
-A Simple Web Server
+### A Simple Web Server
 
 `server.js`:
 
@@ -32,11 +50,26 @@ http.createServer(app).listen(8080, function () {
 node server.js
 ```
 
-An Express App
+### Generate a Secure Random Key
+
+This generates a hex-encoded 128-bit random key.
+
+```bash
+node -p 'crypto.randomBytes(16).toString("hex")'
+```
+
+This generates a url-safe base64 256-bit random key.
+
+```bash
+node -p 'crypto.randomBytes(32).toString("base64")
+            .replace(/\+/g, "-").replace(/\//g, "_").replace(/=/g, "")'
+```
+
+### An Express App
 
 ```bash
 mkdir my-server
-pushd my-server
+pushd my-server/
 npm init
 npm install --save express
 ```
@@ -50,10 +83,10 @@ var express = require('express');
 var app = express();
 
 app.use('/', function (req, res, next) {
-  res.end("Hello, World!");
+  res.end('Hello, World!');
 });
 
-module.exports = app;</code></pre>
+module.exports = app;
 ```
 
 `server.js`: