docs/improve readme and alias text (#60)

* fix readme TOC links

* add note for removing aliases

* give a clear msg for removing aliases
This commit is contained in:
Sahil Bansal
2025-07-30 16:42:02 +05:30
committed by GitHub
parent 6d39fc0dde
commit 2cbb24b3b1
2 changed files with 6 additions and 4 deletions
+5 -3
View File
@@ -61,9 +61,9 @@ pnpm add <package-name>
- [Install Aliases](#install-aliases)
- [Remove Aliases](#remove-aliases)
- [Usage](#usage)
- [Recommended: Automated Setup](#recommended)
- [Alternative: Manual Commands](#alternative)
- [Lockfile Installation](#lockfile)
- [Recommended: Automated Setup](#recommended-automated-setup)
- [Alternative: Manual Commands](#alternative-manual-commands)
- [Lockfile Installation](#lockfile-installation)
- [Silent Mode](#silent-mode)
- [Dry Run](#dry-run)
- [Verbose Mode](#verbose-mode)
@@ -151,6 +151,8 @@ This will:
- Remove the source line from your shell configuration files
- Delete the ~/.pmg.rc file
> ⚠️ Note: Aliases might still be active in your **current terminal session**. Restart your terminal or use `unalias <cmd>` to remove them instantly.
## Usage
### Recommended: Automated Setup
+1 -1
View File
@@ -135,7 +135,7 @@ func (a *AliasManager) Remove() error {
return fmt.Errorf("failed to clean shell configs: %w", err)
}
fmt.Println("✅ PMG aliases and shell config changes removed.")
fmt.Println("✅ PMG config removed. Existing aliases need a shell restart.")
return nil
}