Add readme

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..16e3cd0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Autoenv for zsh
+
+This is is a zsh optimized version of
+[autoenv](https://github.com/kennethreitz/autoenv)
+
+## Why a zsh version
+
+  * Auto-completion will work rather than vomit
+  * No stupid error messages
+  * It's elegant to use the built in `chpwd_functions`
+
+## Installation
+
+Using [antigen](https://github.com/zsh-users/antigen)
+
+    antigen-bundle Tarrasch/zsh-autoenv
+
+## Credits
+
+The code was mostly copied from [Joshua Clayton](https://github.com/joshuaclayton)