Added 'Show off' section to README.

Shrikant Sharat
1 parent de8d00ed42
Showing 1 changed file with 57 additions and 1 deletions Side-by-side Diff
README.mkd
@@ -9,7 +9,63 @@ incompatible changes now and then, until we have a pretty stable system we can
 reason about. **Please** read the commit comments of the changesets when you
 pull a new version of antigen.
  
-# Quick Usage
+# Show off
+
+> Enough talk. Let's fight!
+>   -- Po, Kung-fu Panda.
+
+You're going to experience antigen right in your open shell. No `.zshrc`
+tweaking and reading the rest of this documentation. Kinda like an ice-cream
+sample, if you will.
+
+Get and load antigen.
+
+    curl https://raw.github.com/zsh-users/antigen/master/antigen.zsh > antigen.zsh
+    source antigen.zsh
+
+There. You now have all the antigen goodies. Let's try install some plugins. How
+about some color to start with. Get the syntax highlighting plugin by running
+
+    antigen-bundle zsh-users/zsh-syntax-highlighting
+
+Now let it do its thing and once its done and you're back at your prompt, try
+and type a command. See that? Colors!
+
+So, you do git? ruby? git and ruby? There are lots of awesome plugins over at
+oh-my-zsh. Treat yourself to some.
+
+    antigen-bundle robbyrussell/oh-my-zsh plugins/ruby
+    antigen-bundle robbyrussell/oh-my-zsh plugins/git
+
+There are lots of plugins out there in the wild and people are writing zsh
+utilities as small scripts all the time. Antigen is compatible with all of them.
+The plugins and scripts don't need any special handling to be compatible with
+antigen.
+
+The side effect of this is that you can tell antigen to grab just about anything
+from anyone's `dotfiles` repo, as long as it is in a directory under any repo on
+github.
+
+And themes? How would you like a fancy new prompt for yourself?
+
+    antigen-theme funky
+
+No? Not your taste? There are many themes available to you, check out the
+oh-my-zsh's page on themes. (You can currently only install themes from
+robbyrussell's, i.e., the canonical oh-my-zsh repo).
+
+Note: Many of those plugins and especially themes, assume you have the core
+library of oh-my-zsh loaded. So, if you want to experiment further, issue a
+
+    antigen-lib
+
+and continue until you're tired. At which point you can come back to this page
+;)
+
+# Usage
+
+So, now that you're here, I'll assume you are convinced and want antigen running
+your shell all the time. Sweet. Let's do it.
  
 First, clone this repo, probably as a submodule if you have your dotfiles in a
 git repo,
...	...	@@ -9,7 +9,63 @@ incompatible changes now and then, until we have a pretty stable system we can
9	9	reason about. Please read the commit comments of the changesets when you
10	10	pull a new version of antigen.
11	11
12		-# Quick Usage
	12	+# Show off
	13	+
	14	+> Enough talk. Let's fight!
	15	+> -- Po, Kung-fu Panda.
	16	+
	17	+You're going to experience antigen right in your open shell. No `.zshrc`
	18	+tweaking and reading the rest of this documentation. Kinda like an ice-cream
	19	+sample, if you will.
	20	+
	21	+Get and load antigen.
	22	+
	23	+ curl https://raw.github.com/zsh-users/antigen/master/antigen.zsh > antigen.zsh
	24	+ source antigen.zsh
	25	+
	26	+There. You now have all the antigen goodies. Let's try install some plugins. How
	27	+about some color to start with. Get the syntax highlighting plugin by running
	28	+
	29	+ antigen-bundle zsh-users/zsh-syntax-highlighting
	30	+
	31	+Now let it do its thing and once its done and you're back at your prompt, try
	32	+and type a command. See that? Colors!
	33	+
	34	+So, you do git? ruby? git and ruby? There are lots of awesome plugins over at
	35	+oh-my-zsh. Treat yourself to some.
	36	+
	37	+ antigen-bundle robbyrussell/oh-my-zsh plugins/ruby
	38	+ antigen-bundle robbyrussell/oh-my-zsh plugins/git
	39	+
	40	+There are lots of plugins out there in the wild and people are writing zsh
	41	+utilities as small scripts all the time. Antigen is compatible with all of them.
	42	+The plugins and scripts don't need any special handling to be compatible with
	43	+antigen.
	44	+
	45	+The side effect of this is that you can tell antigen to grab just about anything
	46	+from anyone's `dotfiles` repo, as long as it is in a directory under any repo on
	47	+github.
	48	+
	49	+And themes? How would you like a fancy new prompt for yourself?
	50	+
	51	+ antigen-theme funky
	52	+
	53	+No? Not your taste? There are many themes available to you, check out the
	54	+oh-my-zsh's page on themes. (You can currently only install themes from
	55	+robbyrussell's, i.e., the canonical oh-my-zsh repo).
	56	+
	57	+Note: Many of those plugins and especially themes, assume you have the core
	58	+library of oh-my-zsh loaded. So, if you want to experiment further, issue a
	59	+
	60	+ antigen-lib
	61	+
	62	+and continue until you're tired. At which point you can come back to this page
	63	+;)
	64	+
	65	+# Usage
	66	+
	67	+So, now that you're here, I'll assume you are convinced and want antigen running
	68	+your shell all the time. Sweet. Let's do it.
13	69
14	70	First, clone this repo, probably as a submodule if you have your dotfiles in a
15	71	git repo,