Skip to content

Commit

Permalink
Chore(documentation): Update install and usage instructions to sugges…
Browse files Browse the repository at this point in the history
…t @inquirer/prompts first
  • Loading branch information
SBoudrias committed Jul 21, 2024
1 parent 1544c13 commit 09a356c
Show file tree
Hide file tree
Showing 9 changed files with 198 additions and 9 deletions.
23 changes: 22 additions & 1 deletion packages/checkbox/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,25 @@ Simple interactive command line prompt to display a list of checkboxes (multi se
<tr>
<td>

```sh
npm install @inquirer/prompts
```

</td>
<td>

```sh
yarn add @inquirer/prompts
```

</td>
</tr>
<tr>
<td colSpan="2" align="center">Or</td>
</tr>
<tr>
<td>

```sh
npm install @inquirer/checkbox
```
Expand All @@ -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',
Expand Down
23 changes: 22 additions & 1 deletion packages/confirm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,25 @@ Simple interactive command line prompt to gather boolean input from users.
<tr>
<td>

```sh
npm install @inquirer/prompts
```

</td>
<td>

```sh
yarn add @inquirer/prompts
```

</td>
</tr>
<tr>
<td colSpan="2" align="center">Or</td>
</tr>
<tr>
<td>

```sh
npm install @inquirer/confirm
```
Expand All @@ -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?' });
```
Expand Down
23 changes: 22 additions & 1 deletion packages/editor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,25 @@ Prompt that'll open the user preferred editor with default content and allow for
<tr>
<td>

```sh
npm install @inquirer/prompts
```

</td>
<td>

```sh
yarn add @inquirer/prompts
```

</td>
</tr>
<tr>
<td colSpan="2" align="center">Or</td>
</tr>
<tr>
<td>

```sh
npm install @inquirer/editor
```
Expand All @@ -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',
Expand Down
23 changes: 22 additions & 1 deletion packages/expand/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,25 @@ Compact single select prompt. Every option is assigned a shortcut key, and selec
<tr>
<td>

```sh
npm install @inquirer/prompts
```

</td>
<td>

```sh
yarn add @inquirer/prompts
```

</td>
</tr>
<tr>
<td colSpan="2" align="center">Or</td>
</tr>
<tr>
<td>

```sh
npm install @inquirer/expand
```
Expand All @@ -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',
Expand Down
23 changes: 22 additions & 1 deletion packages/input/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,25 @@ Interactive free text input component for command line interfaces. Supports vali
<tr>
<td>

```sh
npm install @inquirer/prompts
```

</td>
<td>

```sh
yarn add @inquirer/prompts
```

</td>
</tr>
<tr>
<td colSpan="2" align="center">Or</td>
</tr>
<tr>
<td>

```sh
npm install @inquirer/input
```
Expand All @@ -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' });
```
Expand Down
23 changes: 22 additions & 1 deletion packages/number/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,25 @@ Interactive free number input component for command line interfaces. Supports va
<tr>
<td>

```sh
npm install @inquirer/prompts
```

</td>
<td>

```sh
yarn add @inquirer/prompts
```

</td>
</tr>
<tr>
<td colSpan="2" align="center">Or</td>
</tr>
<tr>
<td>

```sh
npm install @inquirer/number
```
Expand All @@ -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' });
```
Expand Down
23 changes: 22 additions & 1 deletion packages/password/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,25 @@ Interactive password input component for command line interfaces. Supports input
<tr>
<td>

```sh
npm install @inquirer/prompts
```

</td>
<td>

```sh
yarn add @inquirer/prompts
```

</td>
</tr>
<tr>
<td colSpan="2" align="center">Or</td>
</tr>
<tr>
<td>

```sh
npm install @inquirer/password
```
Expand All @@ -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' });
```
Expand Down
23 changes: 22 additions & 1 deletion packages/rawlist/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,25 @@ Simple interactive command line prompt to display a raw list of choices (single
<tr>
<td>

```sh
npm install @inquirer/prompts
```

</td>
<td>

```sh
yarn add @inquirer/prompts
```

</td>
</tr>
<tr>
<td colSpan="2" align="center">Or</td>
</tr>
<tr>
<td>

```sh
npm install @inquirer/rawlist
```
Expand All @@ -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',
Expand Down
23 changes: 22 additions & 1 deletion packages/select/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,25 @@ Simple interactive command line prompt to display a list of choices (single sele
<tr>
<td>

```sh
npm install @inquirer/prompts
```

</td>
<td>

```sh
yarn add @inquirer/prompts
```

</td>
</tr>
<tr>
<td colSpan="2" align="center">Or</td>
</tr>
<tr>
<td>

```sh
npm install @inquirer/select
```
Expand All @@ -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',
Expand Down

0 comments on commit 09a356c

Please sign in to comment.