README.md

   1 # zpe
   2 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.
   3
   4 ## Usage
   5   1. Source the script in your `zshrc`
   6   2. Add a list of the plugin repositories in `~/.config/zpe/repositories`
   7     * Use the full URL, either SSH or HTTP
   8     * Comments can be added with a #
   9   3. Run `zpe-clone` to pull the repositories
  10   4. Source the plugin in your zshrc using the `zpe-source` command.
  11     * For each plugin, locate the source-able file (usually contains the word init, or has the .plugin.zsh extension)
  12     * Add it to your zshrc using the following syntax: `zpe-source <plugin name>/<source-able file name>`.
  13     * Make sure that this goes after sourcing the `zpe.zsh` script.
  14   * Extra commads
  15     * `zpe-pull` updates the repositories
  16     * `zpe-clean` removes any cloned repositories that are no longer in `repositories` file
  17
  18 ## Motivation
  19 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.
  20
  21 ## License
  22 Copyright Armaan Bhojwani
  23 MIT License, see COPYING for more information