From 7e0aca7cecb0d58c36a949d5b052beb01d82c60c Mon Sep 17 00:00:00 2001 From: Shrikant Sharat Date: Sun, 3 Jun 2012 16:21:24 +0530 Subject: [PATCH] Add notes about bundle's new short syntax. The `bundle` command got some new super short syntax sugar. Notes about it in the README. --- README.mkd | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.mkd b/README.mkd index a528490..fd06146 100644 --- a/README.mkd +++ b/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 + +This will add the `plugins/` 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 [ [ []]] where `` 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. -- 2.0.0