README.md in legit-0.0.13 vs README.md in legit-0.0.14
- old
+ new
@@ -9,13 +9,22 @@
## Installation
```bash
$ gem install legit
```
+Requires ruby >= 1.8.7
+
## Usage
Run `legit` with no options to see a list of commands and options.
+### legit checkout
+Recommended alias: `lco`
+
+Fuzzy git checkout
+
+
+
### Setting Up a `catch-todos` `pre-commit` Hook
1. Add the following to `.git/hooks/pre-commit` in the desired repository:
```bash
@@ -32,15 +41,10 @@
```
legit catch-todos --disable # will not check todos until re-enabled
legit catch-todos --enable # sets it back to normal
```
-Note: if you use a graphical git tool (such as [SourceTree](http://http://www.sourcetreeapp.com/) for OS X), you may need read the following:
-
-RVM and similar tools do store executables in custom locations instead of the standard locations for executables such as `/usr/bin`. Since your `.bash_profile` (or similar) might not be executed by your GUI tool, you may need to create a symlink to legit in a location that is in the tool's default path. `/usr/bin` is usually included, so this should do:
-```bash
-sudo ln -s $(which legit) /usr/bin/legit # find where RVM is storing legit and add a symlink to it in /usr/bin
-```
+Note: some graphical git tools may not run git hooks.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)