X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=5428eadf6d4b38b74d1c103ff94dfaea16648b7a;hb=910dae7a527d5a36d91eafb11da567ecb22fc2ed;hp=78f9fe202b7d2a6cab54aec8f1aa06d95db2474f;hpb=54ac4f56a7e3152bfcda1497936e0ac12d0febf5;p=zpe.git diff --git a/README.md b/README.md index 78f9fe2..5428ead 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ # 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.zsh` 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 - * `zpe-clean` removes any cloned repositories that are no longer in `repositories` file + * `zpe-clean` removes any cloned repositories that are no longer in the `repositories` file + * `zpe` opens the `repositories` file in $EDITOR ## Motivation All of the other available plugin managers try to get way too fancy. I just need something to automatically clone git repositories, and make my config nice and portable. The script is intentionally highly extensible and feature-minimal. ## License -Copyright Armaan Bhojwani 2020 -MIT License, see COPYING for more information +Copyright Armaan Bhojwani 2021, MIT License, see the LICENSE file for more information