X-Git-Url: https://git.armaanb.net/?a=blobdiff_plain;f=README.md;h=5428eadf6d4b38b74d1c103ff94dfaea16648b7a;hb=910dae7a527d5a36d91eafb11da567ecb22fc2ed;hp=b78358068e9bc9dee2a0da25627a9c7acbdc91e6;hpb=c7e9ad402a7d41735bc89f7e41e6406c63cbad8f;p=zpe.git

diff --git a/README.md b/README.md
index b783580..5428ead 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,20 @@
 # zpe
-A utility to ease the management of zsh plugins. This is NOT a complete zsh plugin manager, I reccomend [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
-Just put a list of git repos (full url, either ssh or http) in `~/.config/zpe/repositories`, and then put `source /path/to/zpe.zsh` in your zshrc. Install plugins using `zpe-clone`, update them using `zpe-pull` and remove unused ones using `zpe-clean`. You must manually source the plugins in your zshrc, however this is made easier using the `zpe-source` command. For each plugin, locate the source-able file (usually contains the word init, or has the .plugin.zsh extension) and 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.zsh` script.
+### Basic usage
+  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 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
+  * `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 to fancy. I just need something to automatically clone git repositories, and make my system nice and portable. I set myself a code limit of 100 sloc to try and stop feature creep. The script is intentionally very extensible and feature-minimal.
+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  
-MIT License, see COPYING for more information
+Copyright Armaan Bhojwani 2021, MIT License, see the LICENSE file for more information