readme

README.md

@@ -0,0 +1,44 @@
+repl-completion
+===============
+
+This project contains completion files for use with [repl(1)][0].
+
+
+Installation
+------------
+
+Because `repl` looks for ~/.repl by default, this is the simplest way
+to install repl-completion:
+
+    cd ~
+    git clone git://github.com/defunkt/repl-completion.git .repl
+
+Want to update it after you've installed it?
+
+    cd ~/.repl
+    git pull origin master
+
+It's as simple as that.
+
+
+Contributing
+------------
+
+Once you've made your great commits:
+
+1. [Fork][1] repl-completion
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. Create an [Issue][2] with a link to your branch
+5. That's it!
+
+
+Author
+------
+
+Chris Wanstrath :: chris@ozmm.org :: @defunkt
+
+
+[0]: http://github.com/defunkt/repl#readme
+[1]: http://help.github.com/forking/
+[2]: http://github.com/defunkt/repl/issues