From 3a3c98f867e06a6ec7609a60df5e5276c946d0b5 Mon Sep 17 00:00:00 2001 From: "Benjamin E. Coe" Date: Sun, 2 May 2021 11:53:56 -0700 Subject: [PATCH] docs: document hideBin (#1932) Fixes #1871 --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 856779f75..3494c14af 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,8 @@ $ ./plunder.js --ships 12 --distance 98.7 Retreat from the xupptumblers! ``` +> Note: `hideBin` is a shorthand for [`process.argv.slice(2)`](https://nodejs.org/en/knowledge/command-line/how-to-parse-command-line-arguments/). It has the benefit that it takes into account variations in some environments, e.g., [Electron](https://github.com/electron/electron/issues/4690). + ### Complex Example ```javascript