Redesign clean command

[zpe.git] / README.md

diff --git a/README.md b/README.md
index b78358068e9bc9dee2a0da25627a9c7acbdc91e6..7eebd1c3a3a6ba869f602358068db41087dbb814 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,19 @@
 # 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 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.
 
 ## 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.
+  1. Source the script in your `zshrc`
+  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.zsh` script.
+  * Extra commads
+    * `zpe-pull` updates the repositories
+    * `zpe-clean` removes any cloned repositories that are no longer in `repositories` file
 
 ## 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.