Add docs on --no-local-clone and some examples.

Shrikant Sharat
1 parent 7f742ef265
Showing 1 changed file with 23 additions and 5 deletions Side-by-side Diff
README.mkd
@@ -211,11 +211,29 @@ a shell, put it in your `.zshrc`.
  
 Other keyword-only arguments accepted:
  
-`branch` &mdash; 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}` &mdash; 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` &mdash; 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
...	...	@@ -211,11 +211,29 @@ a shell, put it in your `.zshrc`.
211	211
212	212	Other keyword-only arguments accepted:
213	213
214		-`branch` — Specify the branch of the git repo to be used for this bundle.
215		-Please note that if you specify two plugins to be loaded from the same git repo,
216		-but different branches, then two separate clones of this repo will be
217		-maintained. This is a small implementation detail and shouldn't influence you in
218		-any way.
	214	+`--branch={git-branch-name}` — Specify the branch of the git repo to be
	215	+used for this bundle (without the braces of course). The default is whatever
	216	+branch the clone comes with, which is usually `master`. For example,
	217	+
	218	+ antigen-bundle github-user/repo --branch=develop
	219	+
	220	+This will get the plugin as in the branch `develop`.
	221	+
	222	+Note that if you specify two plugins to be loaded from the same git repo, but
	223	+different branches, then two separate clones of this repo will be maintained.
	224	+This is a small implementation detail and shouldn't influence you in any way.
	225	+
	226	+`--no-local-clone` — This command can be useful if you are developing a
	227	+plugin and already have a clone on your local file system. If this argument is
	228	+not given, even if the given repo url is a local path, a clone is made in the
	229	+`$ADOTDIR/repos`, and the plugin is loaded from that clone. But, if you give
	230	+this argument, the plugin is sourced straight from the repo location, without
	231	+creating a clone. For example,
	232	+
	233	+ antigen-bundle /absolute/path/to/the/plugin --no-local-clone
	234	+
	235	+Note that if the repo url is not an absolute local path, this argument has no
	236	+effect.
219	237
220	238	### antigen-bundles
221	239