-
Notifications
You must be signed in to change notification settings - Fork 5
chore: update readme #53
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
commit: |
README.md
Outdated
|
|
||
| ```bash | ||
| source <(my-cli complete zsh) # One-time setup | ||
| my-cli complete zsh >> ~/.zshrc # Permanent setup |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no this is not a good way, we should go the creating a new file way or echo "source <(my-cli complete zsh)" way
README.md
Outdated
|
|
||
| ```bash | ||
| # this generates a completion script for your shell | ||
| npx @bomb.sh/tab pnpm zsh >> ~/.zshrc |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same here, this would bombard the shell configuration with new content
README.md
Outdated
|
|
||
| ## Framework Integration | ||
|
|
||
| Tab includes adapters for popular JavaScript CLI frameworks: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why we have this section duplicated?
README.md
Outdated
| // Add custom completions | ||
| const devCommand = completion.commands.get('dev'); | ||
| const portOption = devCommand?.options.get('--port'); | ||
| if (portOption) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this condition is annoying
README.md
Outdated
| ## Docs | ||
|
|
||
| Other package managers like `npm` and `yarn` can decide whether to support this or not too for more universal support. | ||
| For more detailed documentation, please visit [bombshell docs](https://bomb.sh/docs/tab/)! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i don't think it'd be detailed there, the docs here and on the website are the same
resolves #16