From b33b9e9d4e80494d11855b8691fdb7e4ed4e3069 Mon Sep 17 00:00:00 2001 From: Shrikant Sharat Date: Sun, 16 Sep 2012 21:26:52 +0530 Subject: [PATCH] Fix #24. Add recommendation about plugin structure. Adding the oh-my-zsh way of organising plugins as a recommending way of writing plugins. Though of course, in the spirit of antigen, it is not required. --- README.mkd | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.mkd b/README.mkd index 7fe455c..5e01f7b 100644 --- a/README.mkd +++ b/README.mkd @@ -468,9 +468,13 @@ functionality of antigen. ## Notes on writing plugins -If you are just going to write a single `.sh` file with the goodness you want to -create, just forget about this and go do that. Antigen will work just fine with -such a plugin. +Most shell utilities/plugins are made up of just one file. For a plugin called +`awesomeness`, create a `awesomeness.plugin.zsh` and code away. + +That said, even if you write a single file as a `.sh` file with the goodness you +want to create, antigen will work just fine with it. The `*.plugin.zsh` way is +recommended by antigen, because it is widely used because of the [oh-my-zsh][] +project. If you want to know how antigen loads the plugins, do continue. -- 2.0.0