Skip to content

Commit 2cbb24b

Browse files
authored
docs/improve readme and alias text (#60)
* fix readme TOC links * add note for removing aliases * give a clear msg for removing aliases
1 parent 6d39fc0 commit 2cbb24b

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ pnpm add <package-name>
6161
- [Install Aliases](#install-aliases)
6262
- [Remove Aliases](#remove-aliases)
6363
- [Usage](#usage)
64-
- [Recommended: Automated Setup](#recommended)
65-
- [Alternative: Manual Commands](#alternative)
66-
- [Lockfile Installation](#lockfile)
64+
- [Recommended: Automated Setup](#recommended-automated-setup)
65+
- [Alternative: Manual Commands](#alternative-manual-commands)
66+
- [Lockfile Installation](#lockfile-installation)
6767
- [Silent Mode](#silent-mode)
6868
- [Dry Run](#dry-run)
6969
- [Verbose Mode](#verbose-mode)
@@ -151,6 +151,8 @@ This will:
151151
- Remove the source line from your shell configuration files
152152
- Delete the ~/.pmg.rc file
153153

154+
> ⚠️ Note: Aliases might still be active in your **current terminal session**. Restart your terminal or use `unalias <cmd>` to remove them instantly.
155+
154156
## Usage
155157

156158
### Recommended: Automated Setup

internal/alias/alias.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ func (a *AliasManager) Remove() error {
135135
return fmt.Errorf("failed to clean shell configs: %w", err)
136136
}
137137

138-
fmt.Println("✅ PMG aliases and shell config changes removed.")
138+
fmt.Println("✅ PMG config removed. Existing aliases need a shell restart.")
139139
return nil
140140
}
141141

0 commit comments

Comments
 (0)