From 54ac4f56a7e3152bfcda1497936e0ac12d0febf5 Mon Sep 17 00:00:00 2001 From: Armaan Bhojwani <3fb650a9-b47e-4604-a282-1dd91953b2ee@anonaddy.me> Date: Fri, 13 Nov 2020 15:33:04 -0500 Subject: [PATCH] fix markdown formatting --- README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 7eebd1c..78f9fe2 100644 --- a/README.md +++ b/README.md @@ -1,23 +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 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. ## Usage +### Basic usage 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 # + 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. - * Extra commads - * `zpe-pull` updates the repositories - * `zpe-clean` removes any cloned repositories that are no longer in `repositories` file + 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. + +### Extra commands + * `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. +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 +Copyright Armaan Bhojwani 2020 MIT License, see COPYING for more information -- 2.39.2