Skip to content

Update README.md #42

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.

Sign up for GitHub

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

Merged
donhk merged 1 commit into from
May 16, 2025
Merged

Update README.md #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 12 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,26 +35,23 @@ cargo build --release

### Pre-built binaries

_Coming soon..._

---

## 🔧 Shell Integration

To use `rushstr` as your reverse history search (e.g., replacing `Ctrl+R`):

### Zsh

Add this to your `~/.zshrc`:
# 🔧 MacOS

```zsh
eval "$(rushstr --zsh-shell-conf)"
# one time
brew tap donhk/homebrew-tap
# install
brew install donhk/homebrew-tap/rushstr
rushstr --zsh-shell-conf
source ~/.zshrc
# upgrade
brew upgrade donhk/homebrew-tap/rushstr
```

Then apply the changes:
# 🔧 Linux

```zsh
source ~/.zshrc
curl -sSL https://raw.githubusercontent.com/donhk/rushstr/main/install.sh | zsh
```

---
Expand Down Expand Up @@ -95,4 +92,4 @@ cargo test
cargo release 1.4.0 --no-push --no-tag --no-publish --execute
cargo patch --no-push --no-tag --no-publish --execute
cargo minor --no-push --no-tag --no-publish --execute
```
```