octoleo
/
nativefier
mirror of https://github.com/Llewellynvdm/nativefier.git
2
2
Fork 0
Code Issues Releases Activity

NATIVEFIER_APPS_DIR: document "new in release", rephrase doc to be the most useful to a first-time user

This commit is contained in:
Ronan Jouchet 2022-01-31 17:07:57 -05:00
parent c6debd72e0
commit e7483549af
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
API.md
View File

@ -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

2
src/cli.ts
View File

@ -46,7 +46,7 @@ export function initArgs(argv: string[]): yargs.Argv<RawOptions> {
})
.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',