Add notes about bundle's new short syntax.

The `bundle` command got some new super short syntax sugar. Notes about it in the README.

Add notes about bundle's new short syntax.
The `bundle` command got some new super short syntax sugar. Notes about it in the README.
Shrikant Sharat
1 parent 1abf1faf67
Showing 1 changed file with 19 additions and 5 deletions Side-by-side Diff
README.mkd
@@ -20,11 +20,11 @@ might look like this
     bundle-lib
  
     # Bundles from the default repo (robbyrussell's oh-my-zsh).
-    bundle --loc=plugins/git
-    bundle --loc=plugins/heroku
-    bundle --loc=plugins/pip
-    bundle --loc=plugins/lein
-    bundle --loc=plugins/command-not-found
+    bundle git
+    bundle heroku
+    bundle pip
+    bundle lein
+    bundle command-not-found
  
     # Syntax highlighting bundle.
     bundle zsh-users/zsh-syntax-highlighting
@@ -72,6 +72,14 @@ and your prompt is changed, just for this session of course.
 This is the command you use to tell antigen that you want to use a plugin. The
 simplest usage follows the following syntax
  
+    bundle <plugin-name>
+
+This will add the `plugins/<name>` directory from [robbyrussell's
+oh-my-zsh][oh-my-zsh] (can be changed by setting `ANTIGEN_DEFAULT_REPO_URL`).
+
+However, the above is just syntax sugar for the real syntax of the `bundle`
+command.
+
     bundle [<url> [<loc> [<name>]]]
  
 where `<url>` is the repository url and it defaults to [robbyrussell's
@@ -101,6 +109,12 @@ argument syntax, using which we can rewrite the above as
  
     bundle --loc=plugins/ant
  
+Which is the same as
+
+    bundle ant
+
+(In the short syntax sugar introduced at the start of this section).
+
 Note that you can mix and match positional and keyword arguments. But you can't
 have positional arguments after starting keyword arguments.
...	...	@@ -20,11 +20,11 @@ might look like this
20	20	bundle-lib
21	21
22	22	# Bundles from the default repo (robbyrussell's oh-my-zsh).
23		- bundle --loc=plugins/git
24		- bundle --loc=plugins/heroku
25		- bundle --loc=plugins/pip
26		- bundle --loc=plugins/lein
27		- bundle --loc=plugins/command-not-found
	23	+ bundle git
	24	+ bundle heroku
	25	+ bundle pip
	26	+ bundle lein
	27	+ bundle command-not-found
28	28
29	29	# Syntax highlighting bundle.
30	30	bundle zsh-users/zsh-syntax-highlighting
...	...	@@ -72,6 +72,14 @@ and your prompt is changed, just for this session of course.
72	72	This is the command you use to tell antigen that you want to use a plugin. The
73	73	simplest usage follows the following syntax
74	74
	75	+ bundle <plugin-name>
	76	+
	77	+This will add the `plugins/<name>` directory from [robbyrussell's
	78	+oh-my-zsh][oh-my-zsh] (can be changed by setting `ANTIGEN_DEFAULT_REPO_URL`).
	79	+
	80	+However, the above is just syntax sugar for the real syntax of the `bundle`
	81	+command.
	82	+
75	83	bundle [<url> [<loc> [<name>]]]
76	84
77	85	where `<url>` is the repository url and it defaults to [robbyrussell's
...	...	@@ -101,6 +109,12 @@ argument syntax, using which we can rewrite the above as
101	109
102	110	bundle --loc=plugins/ant
103	111
	112	+Which is the same as
	113	+
	114	+ bundle ant
	115	+
	116	+(In the short syntax sugar introduced at the start of this section).
	117	+
104	118	Note that you can mix and match positional and keyword arguments. But you can't
105	119	have positional arguments after starting keyword arguments.
106	120