Docs on using inline plugin installation.

Shrikant Sharat
1 parent 592f1460b0
Showing 1 changed file with 29 additions and 1 deletions Side-by-side Diff
README.mkd
@@ -142,13 +142,41 @@ This is something you might not want to put in your `.zshrc`. Instead, run it to
 install all the recorded bundles, using the `bundle` command. It has the
 following syntax.
  
-    bundle-install [--update]
+    bundle-install [--update] [<plugin-spec>]
  
 The optional `--update` argument can be given to update all your plugins from
 the server. By default, `bundle-install` does *not* check for updates on the
 plugins. It just installs them, if there is a cached copy available and if its
 not already installed.
  
+The other argument part illustrated above is the `<plugin-spec>`. Other than the
+optional `--update` argument, everything else is considered as describing a
+particular plugin to be installed. So, a command like
+
+    bundle-install <plugin-spec>
+
+is **almost** equivalent to
+
+    bundle <plugin-spec>
+    bundle-install
+
+I says **almost** because in the former, *only* the said plugin is installed and
+is usable immediately. This kind of invocation is supposed to be used directly
+from the shell, not added to your `.zshrc`. The idea is to let you try out new
+plugins you come across. For example,
+
+    bundle-install lol
+
+After that, you have the `lol` plugin ready to be used right there. You can try
+it out and if you like it, you can add the following to load it in every new
+shell instance you open
+
+    bundle lol
+
+If you don't want it, the plugin will still stay installed, but won't be used.
+No harm done, but you can run `bundle-cleanup` to clean up such stray plugins
+that you don't use. Documentation for that command further down.
+
 ## bundle-install!
  
 This is the same as running
...	...	@@ -142,13 +142,41 @@ This is something you might not want to put in your `.zshrc`. Instead, run it to
142	142	install all the recorded bundles, using the `bundle` command. It has the
143	143	following syntax.
144	144
145		- bundle-install [--update]
	145	+ bundle-install [--update] [<plugin-spec>]
146	146
147	147	The optional `--update` argument can be given to update all your plugins from
148	148	the server. By default, `bundle-install` does not check for updates on the
149	149	plugins. It just installs them, if there is a cached copy available and if its
150	150	not already installed.
151	151
	152	+The other argument part illustrated above is the `<plugin-spec>`. Other than the
	153	+optional `--update` argument, everything else is considered as describing a
	154	+particular plugin to be installed. So, a command like
	155	+
	156	+ bundle-install <plugin-spec>
	157	+
	158	+is almost equivalent to
	159	+
	160	+ bundle <plugin-spec>
	161	+ bundle-install
	162	+
	163	+I says almost because in the former, only the said plugin is installed and
	164	+is usable immediately. This kind of invocation is supposed to be used directly
	165	+from the shell, not added to your `.zshrc`. The idea is to let you try out new
	166	+plugins you come across. For example,
	167	+
	168	+ bundle-install lol
	169	+
	170	+After that, you have the `lol` plugin ready to be used right there. You can try
	171	+it out and if you like it, you can add the following to load it in every new
	172	+shell instance you open
	173	+
	174	+ bundle lol
	175	+
	176	+If you don't want it, the plugin will still stay installed, but won't be used.
	177	+No harm done, but you can run `bundle-cleanup` to clean up such stray plugins
	178	+that you don't use. Documentation for that command further down.
	179	+
152	180	## bundle-install!
153	181
154	182	This is the same as running