Skip to content

Commit 33a2072

Browse files
committed
updated readme
1 parent df5eb03 commit 33a2072

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,21 @@
1111

1212
### Installation:
1313

14-
- Install the `gh-dash` CLI via npm, or mark autoinstall as true in the config function
14+
- Install the 'gh' command line tool for your OS from [GitHub CLI](https://cli.github.com/).
15+
16+
e.g. for macOS:
1517

1618
```bash
17-
npm install -g @openai/gh-dash
19+
brew install gh
1820
```
1921

20-
- Grab an API key from OpenAI and set it in your environment variables:
21-
- Note: You can also set it in your `~/.bashrc` or `~/.zshrc` file to persist across sessions, but be careful with security. Especially if you share your config files.
22+
- Install the `gh-dash` TUI as a plugin from the `gh` command, or mark autoinstall as true in the config function
2223

2324
```bash
24-
export OPENAI_API_KEY=your_api_key
25+
gh extension install dlvhdr/gh-dash
2526
```
2627

27-
- Use your plugin manager, e.g. lazy.nvim:
28+
- Use your plugin manager to install, e.g. lazy.nvim:
2829

2930
```lua
3031
return {
@@ -46,6 +47,7 @@ return {
4647
},
4748
}
4849
```
50+
- If you are not using Lazy, I assume you can figure out how to install the plugin yourself by cloning the repo.
4951

5052
### Usage:
5153
- Call `:gh-dash` (or `:gh-dashToggle`) to open or close the gh-dash popup.

0 commit comments

Comments
 (0)