Skip to content

docs: modern installation guide #3

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
sakebook merged 2 commits into from
Jan 6, 2026
Merged

docs: modern installation guide #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7cd4f65
docs: clean up readme and adding sheldon support
sakebook Jan 6, 2026
0751b77
docs: clean up plugin managers and add sheldon
sakebook Jan 6, 2026
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
40 changes: 20 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,7 @@ Run this command to install `gsw` to `~/.gsw` and update your `.zshrc` automatic
curl -sL https://raw.githubusercontent.com/sakebook/gsw/main/install.sh | bash
```

### Method 2: Plugin Managers

**zplug:**
```zsh
zplug "sakebook/gsw"
```

**antigen:**
```zsh
antigen bundle sakebook/gsw
```

**Oh My Zsh (Custom)**:
Clone into custom plugins:
```bash
git clone https://github.com/sakebook/gsw.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/gsw
```
Then add `gsw` to your plugins list in `~/.zshrc`.

### Method 3: Manual
### Method 2: Manual Install

1. Clone the repo:
```bash
Expand All @@ -51,6 +32,25 @@ Then add `gsw` to your plugins list in `~/.zshrc`.
source ~/.gsw/gsw.sh
```

### Plugin Managers (Zsh)

<details>
<summary>Click to expand configuration examples</summary>

**zplug:**
```zsh
zplug "sakebook/gsw", use:gsw.sh
```

**sheldon:**
```toml
[plugins.gsw]
github = "sakebook/gsw"
use = ["gsw.sh"]
```

</details>

## Usage

### Global Switch (`gsw`)
Expand Down