initial commit

README.md

@@ -1,2 +1,29 @@
-# dotfiles
-Collection of various config files
+# Dotfiles
+
+## Overview
+
+This repo is a skeleton/template repo for tracking my dotfiles.  It contains a utility ([dfm](https://github.com/justone/dfm)) to help with managing and
+updating your dotfiles.
+
+## Using this repo
+
+First, fork this repo.
+
+Then, add your dotfiles:
+
+    $ git clone https://github.com/Eragos/dotfiles.git .dotfiles
+    $ cd .dotfiles
+    $  # add and edit files you want
+    $ git push origin master
+
+Finally, to install your dotfiles onto a new system:
+
+    $ cd $HOME
+    $ git clone git@github.com:username/dotfiles.git .dotfiles
+    $ ./.dotfiles/bin/dfm install # creates symlinks to install files
+
+## Full documentation
+
+For more information, check out the [wiki](http://github.com/justone/dotfiles/wiki).
+
+You can also run <tt>dfm --help</tt>.