]> git.armaanb.net Git - zpe.git/blobdiff - README.md
Make shell agnostic
[zpe.git] / README.md
index 277acaf4d2aa58f3eb84115ac2cf57650ffeca77..5428eadf6d4b38b74d1c103ff94dfaea16648b7a 100644 (file)
--- 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 <plugin name>/<source-able file name>`. 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 <plugin name>/<source-able file name>`. Make sure that this goes after sourcing the `zpe.sh` script.
 
 ### Extra commands
   * `zpe-pull` updates the repositories