Added more documentation to zshrcd.

2 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4ca4b51
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Rahm's Zsh Files.
+
+This is my hand-rolled ZSH configuration system.
+
+It's pretty simple how it works. Each of the `*.zsh` files in this directory are
+sourced in alphabetical order by the `zshrc` file.
+
+Local configurations are stored in the `local/ directory`. The same rules apply;
+however, these files are covered by the `.gitignore` and thus are designed to be
+local-only configuration that is not committed to git.
+
+Prompts are selected based no the hostname and are stored in the `prompts/`
+folder. Specifically, `prompts/$(hostname).zsh` is sourced.
+
+## Installation
+
+```sh
+git clone git://git.josher.dev/zshrcd.git ~/.zshrc.d && \
+    ln -s ~/.zshrc.d/zshrc ~/.zshrc
+```
diff --git a/zshrc b/zshrc
index 720f3ca..440baa5 100644
--- a/zshrc
+++ b/zshrc
@@ -1,3 +1,6 @@
+# Loads the other files in order. This file should not be touched. It is used
+# simply as a way to load the other files in the .zshrc.d folder.
+
 for f in $HOME/.zshrc.d/*.zsh ; do
   source "$f"
 done || true