Add a note to README about heredoc's indentation.

Shrikant Sharat
1 parent ffad68b978
Showing 1 changed file with 3 additions and 0 deletions Side-by-side Diff
README.mkd
@@ -295,6 +295,9 @@ lines and those starting with a `#` are ignored. The rest are passed to
 with the `antigen-bundle` command. See the source if you want to really
 understand how it works. Its a very small function.
  
+*Note*: Indenting the contents inside the EOBUNDLES heredoc is not required for
+antigen-bundles to work. Its allowed (and encouraged) to improve readability.
+
 ### antigen-update
  
 This is something you might not want to put in your `.zshrc`. Instead, run it
...	...	@@ -295,6 +295,9 @@ lines and those starting with a `#` are ignored. The rest are passed to
295	295	with the `antigen-bundle` command. See the source if you want to really
296	296	understand how it works. Its a very small function.
297	297
	298	+Note: Indenting the contents inside the EOBUNDLES heredoc is not required for
	299	+antigen-bundles to work. Its allowed (and encouraged) to improve readability.
	300	+
298	301	### antigen-update
299	302
300	303	This is something you might not want to put in your `.zshrc`. Instead, run it