README.markdown in homesick-0.4.1 vs README.markdown in homesick-0.5.1
- old
+ new
@@ -1,10 +1,10 @@
# homesick
A man's home (directory) is his castle, so don't leave home with out it.
-Homesick is sorta like rip, but for dotfiles. It uses git to clone a repository containing dotfiles, and saves them in `~/.homesick`. It then allows you to symlink all the dotfiles into place with a single command.
+Homesick is sorta like [rip](http://github.com/defunkt/rip), but for dotfiles. It uses git to clone a repository containing dotfiles, and saves them in `~/.homesick`. It then allows you to symlink all the dotfiles into place with a single command.
We call a repository that is compatible with homesick to be a 'castle'. To act as a castle, a repository must be organized like so:
* Contains a 'home' directory
* 'home' contains any number of files and directories that begin with '.'
@@ -22,9 +22,13 @@
homesick clone technicalpickles/pickled-vim
With the castle cloned, you can now link its contents into your home dir:
homesick symlink pickled-vim
+
+If uou use the shorthand syntax for GitHub repositories in your clone, please note you will instead need to run:
+
+ homesick symlink technicalpickles/pickled-vim
If you're not sure what castles you have around, you can easily list them:
homesick list