From 8a80d2b7a57acb5c80df78a29423b719ba54629c Mon Sep 17 00:00:00 2001 From: Shrikant Sharat Date: Thu, 26 Jul 2012 20:32:57 +0530 Subject: [PATCH] Add docs on --no-local-clone and some examples. --- README.mkd | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/README.mkd b/README.mkd index f8dca07..3205c78 100644 --- a/README.mkd +++ b/README.mkd @@ -211,11 +211,29 @@ a shell, put it in your `.zshrc`. Other keyword-only arguments accepted: -`branch` — Specify the branch of the git repo to be used for this bundle. -Please note that if you specify two plugins to be loaded from the same git repo, -but different branches, then two separate clones of this repo will be -maintained. This is a small implementation detail and shouldn't influence you in -any way. +`--branch={git-branch-name}` — Specify the branch of the git repo to be +used for this bundle (without the braces of course). The default is whatever +branch the clone comes with, which is usually `master`. For example, + + antigen-bundle github-user/repo --branch=develop + +This will get the plugin as in the branch `develop`. + +Note that if you specify two plugins to be loaded from the same git repo, but +different branches, then two separate clones of this repo will be maintained. +This is a small implementation detail and shouldn't influence you in any way. + +`--no-local-clone` — This command can be useful if you are developing a +plugin and already have a clone on your local file system. If this argument is +not given, even if the given repo url is a local path, a clone is made in the +`$ADOTDIR/repos`, and the plugin is loaded from that clone. But, if you give +this argument, the plugin is sourced straight from the repo location, without +creating a clone. For example, + + antigen-bundle /absolute/path/to/the/plugin --no-local-clone + +Note that if the repo url is *not* an absolute local path, this argument has no +effect. ### antigen-bundles -- 2.0.0