Add README.md

Include a short description, example usage information, installation
instructions, and license information.

1 files changed, 39 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..67144a7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+qcd
+===
+
+A Bash utility that enables quick `cd`s using shortcuts.
+
+
+## Example
+
+	$ cd code/qcd
+	
+	# Add a shortcut `qcd` for the current directory
+	$ qcd -a qcd .
+	
+	$ cd ~/Desktop/
+	$ qcd qcd
+	$ pwd
+	/Users/professorfarnsworth/code/qcd
+	
+	$ qcd -a another-project ../another-project-dir/
+	$ qcd another-project
+	$ pwd
+	/Users/professorfarnsworth/code/another-project-dir
+	$ qcd qcd
+	$ pwd
+	/Users/professorfarnsworth/code/qcd
+	
+	# Remove the `another-project` shortcut
+	$ qcd -r another-project
+
+
+## Install
+Grab the code and add the following lines to your Bash profile:
+
+	source ~/path/to/qcd
+	source ~/path/to/qcd.bash-completion
+
+
+## License
+Copyright © 2016 Teddy Wing. Licensed under the GNU GPLv3+ (see the included COPYING file).