summaryrefslogtreecommitdiff
path: root/README.textile
diff options
context:
space:
mode:
Diffstat (limited to 'README.textile')
-rw-r--r--README.textile18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.textile b/README.textile
index e06e3a9fc..c3978bef0 100644
--- a/README.textile
+++ b/README.textile
@@ -1,3 +1,7 @@
+A handful of functions, auto-complete helpers, and stuff that makes you shout...
+
+bq. "OH MY ZSHELL!"
+
h2. Setup
1. Clone the repository
@@ -8,7 +12,21 @@ h2. Setup
3. Start / restart zsh (open a new terminal is easy enough..)
+h2. Usage
+
+TODO: Update this..
+
+* Rake autocomplete: @rake (tab)@. Will generate a cache of all your rake tasks and then let you auto-complete and/or select the task to run.
+* ssh autocomplete: @ssh (tab)@ or @scp (tab)@
+* Git branch, it'll tell you which branch you're in when you're in a git repository directory.
+* much much more..
+
+h2. Thanks
+* Rick Olsen (technoweenie) might remember some of the configuration, which I took from a pastie a few years ago.
+* Whoever created the rake autocomplete stuff, which was posted all over the internet a few years ago.
+h2. Help out!
+If you have ideas on how to improve/optimize the configuration, don't hesitate to send pull requests.