Skip to content

Commit 796eeda

Browse files
author
Joanna May
authored
docs: add note about Windows usage (#40)
1 parent 02e67cb commit 796eeda

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ It works on bash and zsh on Linux, macOS, and Windows.
1010

1111
There are several ways to achieve shell completions for CLI commands. Most of them depend on which shell you are using and, in some cases, the terminal.
1212

13-
The approach used by `cli_completion` is to create shell script files in a directory under the user's home ( `~/.dart-cli-completion` for Linux/macOS users) and then source these scripts in the shell initialization files (`~/.zshrc`, for example).
13+
The approach used by `cli_completion` is to create shell script files in a directory under the user's home ( `~/.dart-cli-completion` for Linux/macOS users) and then source these scripts in the shell initialization files (`~/.zshrc`, for example). For Windows users, completion information is stored in local app data (typically something like `C:\Users\You\AppData\Local`). Currently, completion will only work from a bash shell on Windows.
1414

1515
We call this process [installation](#the-installation-process).
1616

1717
Then, scripts are installed and sourced (via `source ~/.zshrc`).
1818

19-
These scripts instruct the shell to call the “completion” subcommand in the CLI when the user presses <TAB>.
19+
These scripts instruct the shell to call the “completion” subcommand in the CLI when the user presses `<TAB>`.
2020

2121
Then, the messages generated by that command will be sent back to the shell, which will take care of formatting it and displaying it to the user as completion suggestions.
2222

23-
We call this process [parsing](#how-parsing-completion-works) .
23+
We call this process [parsing](#how-parsing-completion-works).
2424

2525
### The Installation Process
2626

0 commit comments

Comments
 (0)