Add notes about antigen and -help commands in README.

Shrikant Sharat
1 parent e9bdca5444
Showing 1 changed file with 43 additions and 0 deletions Side-by-side Diff
README.mkd
@@ -140,6 +140,11 @@ and your prompt is changed, just for this session of course.
  
 ## Commands
  
+The following are the commands provided by antigen. Note that the `-` in the
+following commands is kind of optional. You can write `antigen-bundle ...` as
+`antigen bundle` and get away with it. For more details see the help on
+`antigen` command further down in this section.
+
 ### antigen-bundle
  
 This command tells antigen to install (if not already installed) and load the
@@ -325,6 +330,44 @@ However, if you&#39;re a zsh expert and can suggest a way so that this would not be
 necessary, I am very interested in discussing it. Please open up an issue with
 your details. Thanks.
  
+### antigen-help
+
+This exists so that there can be some help right in the command line. Currently
+it doesn't provide much help other than redirecting you to the project page for
+documentation. It is intended to provide more meaning and sub-command specific
+help in the future.
+
+I could use some help here as I'm not that good at writing documentation that
+looks good as output on the command line.
+
+### antigen
+
+This is a parent command that mainly exists for convenience. The idea is the
+following two are the same.
+
+    antigen-list
+    antigen list
+
+and
+
+    antigen-help
+    antigen help
+
+Because of this, we can create aliases like
+
+    alias a=antigen
+    alias an=antigen
+
+and run the antigen commands without making them look annoyingly long.
+
+    a bundle ruby
+    a theme candy
+    a list
+
+And even...
+
+    an update
+
 ## Configuration
  
 The following environment variables can be set to customize the behavior of
...	...	@@ -140,6 +140,11 @@ and your prompt is changed, just for this session of course.
140	140
141	141	## Commands
142	142
	143	+The following are the commands provided by antigen. Note that the `-` in the
	144	+following commands is kind of optional. You can write `antigen-bundle ...` as
	145	+`antigen bundle` and get away with it. For more details see the help on
	146	+`antigen` command further down in this section.
	147	+
143	148	### antigen-bundle
144	149
145	150	This command tells antigen to install (if not already installed) and load the
...	...	@@ -325,6 +330,44 @@ However, if you're a zsh expert and can suggest a way so that this would not be
325	330	necessary, I am very interested in discussing it. Please open up an issue with
326	331	your details. Thanks.
327	332
	333	+### antigen-help
	334	+
	335	+This exists so that there can be some help right in the command line. Currently
	336	+it doesn't provide much help other than redirecting you to the project page for
	337	+documentation. It is intended to provide more meaning and sub-command specific
	338	+help in the future.
	339	+
	340	+I could use some help here as I'm not that good at writing documentation that
	341	+looks good as output on the command line.
	342	+
	343	+### antigen
	344	+
	345	+This is a parent command that mainly exists for convenience. The idea is the
	346	+following two are the same.
	347	+
	348	+ antigen-list
	349	+ antigen list
	350	+
	351	+and
	352	+
	353	+ antigen-help
	354	+ antigen help
	355	+
	356	+Because of this, we can create aliases like
	357	+
	358	+ alias a=antigen
	359	+ alias an=antigen
	360	+
	361	+and run the antigen commands without making them look annoyingly long.
	362	+
	363	+ a bundle ruby
	364	+ a theme candy
	365	+ a list
	366	+
	367	+And even...
	368	+
	369	+ an update
	370	+
328	371	## Configuration
329	372
330	373	The following environment variables can be set to customize the behavior of