Add notes on antigen-bundles command to README.

Shrikant Sharat
1 parent 2fe4683b32
Showing 1 changed file with 31 additions and 0 deletions Side-by-side Diff
README.mkd
@@ -139,6 +139,37 @@ from your shell environment. This allows you to install plugins on the fly and
 try them out. Of course if you want a bundle to be available every time you open
 a shell, put it in your `.zshrc`.
  
+## antigen-bundles
+
+If you have a fair number of bundles, using the `antigen-bundle` command can
+look cumbersome. You can use the `antigen-bundles` command to *bulk* define
+bundles instead of individual calls to `antigen-bundle`.
+
+Usage is pretty straightforward. Just pipe the bundle specifications, just as
+you would give to the `antigen-bundle` command, one per line, into the
+`antigen-bundles` command. The easiest way to do this, is using the heredoc
+syntax.
+
+    antigen-bundles <<EOF
+    # Guess what to install when running an unknown command.
+    command-not-found
+
+    # The heroku tool helper plugin.
+    heroku
+
+    EOF
+
+This is equivalent to
+
+    antigen-bundle command-not-found
+    antigen-bundle heroku
+
+Of course, as you can see, from the lines piped to `antigen-bundles`, empty
+lines and those starting with a `#` are ignored. The rest are passed to
+`antigen-bundle` without any quoting rules applied. They are actually `eval`-ed
+with the `antigen-bundle` command. See the source if you want to really
+understand how it works. Its a very small function.
+
 ## antigen-update
  
 This is something you might not want to put in your `.zshrc`. Instead, run it
...	...	@@ -139,6 +139,37 @@ from your shell environment. This allows you to install plugins on the fly and
139	139	try them out. Of course if you want a bundle to be available every time you open
140	140	a shell, put it in your `.zshrc`.
141	141
	142	+## antigen-bundles
	143	+
	144	+If you have a fair number of bundles, using the `antigen-bundle` command can
	145	+look cumbersome. You can use the `antigen-bundles` command to bulk define
	146	+bundles instead of individual calls to `antigen-bundle`.
	147	+
	148	+Usage is pretty straightforward. Just pipe the bundle specifications, just as
	149	+you would give to the `antigen-bundle` command, one per line, into the
	150	+`antigen-bundles` command. The easiest way to do this, is using the heredoc
	151	+syntax.
	152	+
	153	+ antigen-bundles <<EOF
	154	+ # Guess what to install when running an unknown command.
	155	+ command-not-found
	156	+
	157	+ # The heroku tool helper plugin.
	158	+ heroku
	159	+
	160	+ EOF
	161	+
	162	+This is equivalent to
	163	+
	164	+ antigen-bundle command-not-found
	165	+ antigen-bundle heroku
	166	+
	167	+Of course, as you can see, from the lines piped to `antigen-bundles`, empty
	168	+lines and those starting with a `#` are ignored. The rest are passed to
	169	+`antigen-bundle` without any quoting rules applied. They are actually `eval`-ed
	170	+with the `antigen-bundle` command. See the source if you want to really
	171	+understand how it works. Its a very small function.
	172	+
142	173	## antigen-update
143	174
144	175	This is something you might not want to put in your `.zshrc`. Instead, run it