diff --git a/packages/checkbox/README.md b/packages/checkbox/README.md index 54799ae5c..b03d6b390 100644 --- a/packages/checkbox/README.md +++ b/packages/checkbox/README.md @@ -14,6 +14,25 @@ Simple interactive command line prompt to display a list of checkboxes (multi se +```sh +npm install @inquirer/prompts +``` + + + + +```sh +yarn add @inquirer/prompts +``` + + + + +Or + + + + ```sh npm install @inquirer/checkbox ``` @@ -32,7 +51,9 @@ yarn add @inquirer/checkbox # Usage ```js -import checkbox, { Separator } from '@inquirer/checkbox'; +import { checkbox, Separator } from '@inquirer/prompts'; +// Or +// import checkbox, { Separator } from '@inquirer/checkbox'; const answer = await checkbox({ message: 'Select a package manager', diff --git a/packages/confirm/README.md b/packages/confirm/README.md index bc589e8fd..09400eb08 100644 --- a/packages/confirm/README.md +++ b/packages/confirm/README.md @@ -14,6 +14,25 @@ Simple interactive command line prompt to gather boolean input from users. +```sh +npm install @inquirer/prompts +``` + + + + +```sh +yarn add @inquirer/prompts +``` + + + + +Or + + + + ```sh npm install @inquirer/confirm ``` @@ -32,7 +51,9 @@ yarn add @inquirer/confirm # Usage ```js -import confirm from '@inquirer/confirm'; +import { confirm } from '@inquirer/prompts'; +// Or +// import confirm from '@inquirer/confirm'; const answer = await confirm({ message: 'Continue?' }); ``` diff --git a/packages/editor/README.md b/packages/editor/README.md index beceac76c..72f27de39 100644 --- a/packages/editor/README.md +++ b/packages/editor/README.md @@ -12,6 +12,25 @@ Prompt that'll open the user preferred editor with default content and allow for +```sh +npm install @inquirer/prompts +``` + + + + +```sh +yarn add @inquirer/prompts +``` + + + + +Or + + + + ```sh npm install @inquirer/editor ``` @@ -30,7 +49,9 @@ yarn add @inquirer/editor # Usage ```js -import editor from '@inquirer/editor'; +import { editor } from '@inquirer/prompts'; +// Or +// import editor from '@inquirer/editor'; const answer = await editor({ message: 'Enter a description', diff --git a/packages/expand/README.md b/packages/expand/README.md index f2a1a035a..0273fc917 100644 --- a/packages/expand/README.md +++ b/packages/expand/README.md @@ -15,6 +15,25 @@ Compact single select prompt. Every option is assigned a shortcut key, and selec +```sh +npm install @inquirer/prompts +``` + + + + +```sh +yarn add @inquirer/prompts +``` + + + + +Or + + + + ```sh npm install @inquirer/expand ``` @@ -33,7 +52,9 @@ yarn add @inquirer/expand # Usage ```js -import expand from '@inquirer/expand'; +import { expand } from '@inquirer/prompts'; +// Or +// import expand from '@inquirer/expand'; const answer = await expand({ message: 'Conflict on file.js', diff --git a/packages/input/README.md b/packages/input/README.md index 9d6ff1b48..06c98eba2 100644 --- a/packages/input/README.md +++ b/packages/input/README.md @@ -14,6 +14,25 @@ Interactive free text input component for command line interfaces. Supports vali +```sh +npm install @inquirer/prompts +``` + + + + +```sh +yarn add @inquirer/prompts +``` + + + + +Or + + + + ```sh npm install @inquirer/input ``` @@ -32,7 +51,9 @@ yarn add @inquirer/input # Usage ```js -import input from '@inquirer/input'; +import { input } from '@inquirer/prompts'; +// Or +// import input from '@inquirer/input'; const answer = await input({ message: 'Enter your name' }); ``` diff --git a/packages/number/README.md b/packages/number/README.md index 9aae4512f..bdd9a0548 100644 --- a/packages/number/README.md +++ b/packages/number/README.md @@ -12,6 +12,25 @@ Interactive free number input component for command line interfaces. Supports va +```sh +npm install @inquirer/prompts +``` + + + + +```sh +yarn add @inquirer/prompts +``` + + + + +Or + + + + ```sh npm install @inquirer/number ``` @@ -30,7 +49,9 @@ yarn add @inquirer/number # Usage ```js -import number from '@inquirer/number'; +import { number } from '@inquirer/prompts'; +// Or +// import number from '@inquirer/number'; const answer = await number({ message: 'Enter your age' }); ``` diff --git a/packages/password/README.md b/packages/password/README.md index 9b6fb1cf8..b42199743 100644 --- a/packages/password/README.md +++ b/packages/password/README.md @@ -14,6 +14,25 @@ Interactive password input component for command line interfaces. Supports input +```sh +npm install @inquirer/prompts +``` + + + + +```sh +yarn add @inquirer/prompts +``` + + + + +Or + + + + ```sh npm install @inquirer/password ``` @@ -32,7 +51,9 @@ yarn add @inquirer/password # Usage ```js -import password from '@inquirer/password'; +import { password } from '@inquirer/prompts'; +// Or +// import password from '@inquirer/password'; const answer = await password({ message: 'Enter your name' }); ``` diff --git a/packages/rawlist/README.md b/packages/rawlist/README.md index 65bb3ab25..30dd85b70 100644 --- a/packages/rawlist/README.md +++ b/packages/rawlist/README.md @@ -14,6 +14,25 @@ Simple interactive command line prompt to display a raw list of choices (single +```sh +npm install @inquirer/prompts +``` + + + + +```sh +yarn add @inquirer/prompts +``` + + + + +Or + + + + ```sh npm install @inquirer/rawlist ``` @@ -32,7 +51,9 @@ yarn add @inquirer/rawlist # Usage ```js -import rawlist from '@inquirer/rawlist'; +import { rawlist } from '@inquirer/prompts'; +// Or +// import rawlist from '@inquirer/rawlist'; const answer = await rawlist({ message: 'Select a package manager', diff --git a/packages/select/README.md b/packages/select/README.md index 4a4bf0397..b4adc3fd9 100644 --- a/packages/select/README.md +++ b/packages/select/README.md @@ -14,6 +14,25 @@ Simple interactive command line prompt to display a list of choices (single sele +```sh +npm install @inquirer/prompts +``` + + + + +```sh +yarn add @inquirer/prompts +``` + + + + +Or + + + + ```sh npm install @inquirer/select ``` @@ -32,7 +51,9 @@ yarn add @inquirer/select # Usage ```js -import select, { Separator } from '@inquirer/select'; +import { select, Separator } from '@inquirer/prompts'; +// Or +// import select, { Separator } from '@inquirer/select'; const answer = await select({ message: 'Select a package manager',