From 910dae7a527d5a36d91eafb11da567ecb22fc2ed Mon Sep 17 00:00:00 2001 From: Armaan Bhojwani Date: Mon, 8 Feb 2021 09:40:26 -0500 Subject: [PATCH] Make shell agnostic --- README.md | 6 +++--- zpe.sh | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 277acaf..5428ead 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # zpe -A utility to ease the management of Zsh plugins. This is NOT a complete Zsh plugin manager, I recommend [znap](https://github.com/marlonrichert/zsh-snap/) if you are looking for one. This script just takes the edge off of manually managing them, if you don't want to deal with one of the full-fledged plugin managers. +A utility to ease the management of shell plugins (particularly Zsh). This is NOT a complete plugin manager, I recommend [znap](https://github.com/marlonrichert/zsh-snap/) if you are looking for one. This script just takes the edge off of manually managing them, if you don't want to deal with one of the full-fledged plugin managers. ## Usage ### Basic usage - 1. Source the script in your `zshrc` + 1. Source the script in your shell rc 2. Add a list of the plugin repositories in `~/.config/zpe/repositories`. Use the full URL, either SSH or HTTP, comments can be added with a #. 3. Run `zpe-clone` to pull the repositories - 4. Source the plugin in your zshrc using the `zpe-source` command. For each plugin, locate the source-able file (usually contains the word init, or has the .plugin.zsh extension). Add it to your zshrc using the following syntax: `zpe-source /`. Make sure that this goes after sourcing the `zpe.sh` script. + 4. Source the plugin in your shell rc using the `zpe-source` command. For each plugin, locate the source-able file (usually contains the word init, or has the .plugin.zsh extension). Add it to your shell rc using the following syntax: `zpe-source /`. Make sure that this goes after sourcing the `zpe.sh` script. ### Extra commands * `zpe-pull` updates the repositories diff --git a/zpe.sh b/zpe.sh index dc8cd00..a55df33 100755 --- a/zpe.sh +++ b/zpe.sh @@ -1,5 +1,5 @@ #!/usr/bin/env bash -# ZPE Zsh plugin helper +# ZPE shell plugin helper # Copyright 2021 Armaan Bhojwani, MIT License # Set defaults -- 2.39.2