README.markdown in homesick-0.9.8 vs README.markdown in homesick-1.0.0

- old
+ new

@@ -1,8 +1,11 @@ # homesick +[![Gem Version](https://badge.fury.io/rb/homesick.png)](http://badge.fury.io/rb/homesick) [![Build Status](https://travis-ci.org/technicalpickles/homesick.png?branch=master)](https://travis-ci.org/technicalpickles/homesick) +[![Dependency Status](https://gemnasium.com/technicalpickles/homesick.png)](https://gemnasium.com/technicalpickles/homesick) +[![Code Climate](https://codeclimate.com/github/technicalpickles/homesick.png)](https://codeclimate.com/github/technicalpickles/homesick) Your home directory is your castle. Don't leave your dotfiles behind. 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. @@ -25,15 +28,20 @@ With the castle cloned, you can now link its contents into your home dir: homesick symlink pickled-vim - You can remove symlinks anytime when you don't need them anymore homesick unlink pickled-vim +If you need to add further configuration steps you can add these in a file called '.homesickrc' in the root of a castle. Once you've cloned a castle with a .homesickrc run the configuration with: + + homesick rc CASTLE + +The contents of the .homesickrc file must be valid Ruby code as the file will be executed with Ruby's eval construct. The .homesickrc is also passed the current homesick object during its execution and this is available within the .homesickrc file as the 'self' variable. + If you're not sure what castles you have around, you can easily list them: homesick list To pull your castle (or all castles): @@ -46,14 +54,26 @@ To push your castle: homesick push CASTLE +To open a terminal in the root of a castle: + + homesick cd CASTLE + +To open your default editor in the root of a castle (the $EDITOR environment variable must be set): + + homesick open CASTLE + Not sure what else homesick has up its sleeve? There's always the built in help: homesick help +If you ever want to see what version of homesick you have type: + + homesick version|-v|--version + ## .homesick_subdir `homesick symlink` basically makes symlink to only first depth in `castle/home`. If you want to link nested files/directories, please use .homesick_subdir. For example, when you have castle like this: @@ -127,9 +147,16 @@ | |-- config1 | |-- config2 | `-- config3 `-- .emacs.d `-- elisp + +## Supported Ruby Versions + +Homesick is tested on the following Ruby versions: + +* 1.9.3 +* 2.0.0 ## Note on Patches/Pull Requests * Fork the project. * Make your feature addition or bug fix.