add zpe-clean, zpe-source

[zpe.git] / README.md

diff --git a/README.md b/README.md
index da0195a7aee04bb332ddc3848e1979a0f12c7619..b78358068e9bc9dee2a0da25627a9c7acbdc91e6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
 # zpe
-A darn stupid zsh plugin manager
+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 
+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.
 
 ## Motivation
-All of the other available plugin managers try to get way to fancy. I just need something to automatically clone git repositories and source the files for me. Thats it!
+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.
 
 ## License
 Copyright Armaan Bhojwani