README.md in prj-0.0.1 vs README.md in prj-0.0.2
- old
+ new
@@ -1,26 +1,48 @@
Prj
==========
+[](http://travis-ci.org/v-yarotsky/prj)
+[](https://codeclimate.com/github/v-yarotsky/prj)
+[](http://badge.fury.io/rb/prj)
+
Cd to your project the right way!
-Prj chooses a project directory based on fuzzy matching
+Prj chooses a project directory based on fuzzy matching.
-Usage:
-------
+It finds a project directory (a directory with .git/ or other vcs directory inside) such that it's name
+contains supplied letters in given order. The search is scoped by projects root
+directory, which is specified in ~/.prj.yml config file (Default: ~/Projects).
+See Installation & Configuration section.
-Put this into your .zshrc (.bashrc)
+Installation & Configuration:
+-----------------------------
+1. Install the gem:
-```
-function p() {
- builtin cd "$(prj $1)"
-}
-```
+ ```gem install prj```
-Put a project root directory into ~/.prj, i.e:
+ ([RVM](http://rvm.io) users) check out [this blog post](http://blog.yarotsky.me/2012-12-15-faster-ruby-scripts-startup)
+2. ([oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) users) Put [scripts/zsh/prj.plugin.zsh](https://raw.github.com/v-yarotsky/prj/master/scripts/zsh/prj.plugin.zsh) into ``~/.oh-my-zsh/custom/plugins/prj/prj.plugin.zsh``.
+ Don't forget to enable the plugin in ~/.zshrc
+3. Put a project root directory name into ~/.prj.yml, i.e:
+ ```
+ projects_root: ~/Projects
+ vcs_directories:
+ - .git
+ - .svn
+ - .hg
+ ```
+
+Usage:
+------
+
+With the following directory structure
```
-~/Projects
+~/
+ Projects/
+ my_super_project/
+ rails/
+ love_hate_unicorns/
```
-
-and run ```p letters_from_your_project_folder_name```
+You can reach ``~/Projects/my_super_project`` with ```p msp```