From e7483549aff47f7e1bac3b5b3eaaa8f97ea1b8cc Mon Sep 17 00:00:00 2001 From: Ronan Jouchet Date: Mon, 31 Jan 2022 17:07:57 -0500 Subject: [PATCH] NATIVEFIER_APPS_DIR: document "new in release", rephrase doc to be the most useful to a first-time user --- API.md | 9 +++++++-- src/cli.ts | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/API.md b/API.md index b9938ca..c27e0fd 100644 --- a/API.md +++ b/API.md @@ -115,9 +115,14 @@ The url to point the application at. #### [dest] -Specifies the destination directory to build the app to, defaults to `NATIVEFIER_APPS_DIR` environment variable, or the current working directory if it is not set. +Specifies the destination directory to build the app to. +If no parameter is passed, defaults to the current working directory, +or _[New in 46.0.5]_ the `NATIVEFIER_APPS_DIR` environment variable if set. -**Tip:** Add `export NATIVEFIER_APPS_DIR=~/Applications/` to your `~/.bashrc` , `~/.zshrc`, or similar file to set the default app destination if none is passed. This lets you run `nativefier example.com` and have it automatically save it to your Applications folder on macOS. +**Tip:** Add `export NATIVEFIER_APPS_DIR=~/Applications/` to your +`~/.bashrc` (or `~/.zshrc` or similar) to set the default app destination +if none is passed. This lets you simply run `nativefier example.com` and +have the app automatically built in your Applications folder. #### Help diff --git a/src/cli.ts b/src/cli.ts index c5b732f..62364f5 100755 --- a/src/cli.ts +++ b/src/cli.ts @@ -46,7 +46,7 @@ export function initArgs(argv: string[]): yargs.Argv { }) .positional('outputDirectory', { defaultDescription: - 'NATIVEFIER_APPS_DIR environment variable, or current directory if not set', + 'defaults to the current directory, or env. var. NATIVEFIER_APPS_DIR if set', description: 'the directory to generate the app in', normalize: true, type: 'string',