README.md in warp-dir-1.3.0 vs README.md in warp-dir-1.5.0
- old
+ new
@@ -1,8 +1,11 @@
# Warp Directory
+[](https://rubygems.org/gems/ven table)
[](https://badge.fury.io/rb/warp-dir)
+<br />
+
[](https://travis-ci.org/kigster/warp-dir)
[](https://codeclimate.com/github/kigster/warp-dir)
[](https://codeclimate.com/github/kigster/warp-dir/coverage)
[](https://codeclimate.com/github/kigster/warp-dir)
@@ -25,10 +28,40 @@
The main difference is that `wd` is able to add/remove/list folder "shortcuts", and allows you to jump to these shortcuts from anywhere on the filesystem.
This of this as a folder-navigation super-charge tool that you'd use on a most frequently-used set of folders. This becomes __really useful__ if you are often finding youself going into a small number of deeply nested folders with a long path prefix.
+## Installation
+
+Three steps:
+
+ - `wd` requires a Ruby interpreter version 2.2 higher.
+ - Please Check your default ruby with `ruby --version`. You should see something like "ruby 2.3.0p0....".
+ - If you see version 1.9 or earlier, please upgrade your ruby using the package manager native to your OS.
+ - Install `warp-dir` ruby gem (note: you may need to prefix the command with `sudo` if you are installing into the "system" ruby namespace).
+
+```bash
+$ gem install warp-dir --no-ri --no-rdoc
+```
+
+ - [ ] The last step is to install the `wd` BASH function and auto-completion. This step appends the required shell function to your shell initialization file, that is specified with the `--dotfile` flag.
+
+```bash
+$ warp-dir install --dotfile ~/.bash_profile
+```
+
+After the last step you __need to restart your session__, so – if you are on Mac OS X, – please reopen your Terminal or better yet – [iTerm2](https://www.iterm2.com/), and then type:
+
+```bash
+$ wd help
+```
+
+If the above command returns a properly formatted help that looks like the image below, your setup is now complete!
+
+
+
+
## Usage
__NOTE:__ in the below examples, the characters `~ ❯ ` denote the current shell prompt, showing the current folder you are in. The command to type is on the right hand side of the "❯".
Let's first bookmark a long directory:
@@ -84,14 +117,11 @@
See? I think we thought of everything :)
Happy warping!
-### Detailed Usage
-
-
## `wd` Concept
The overall concept comes from the realization that when we work on the command line, we often do things that `wd` tool provides straight out of the box, such as:
* we often have to deal with a limited number of folders at any given time
@@ -112,34 +142,9 @@
These features will be added shortly:
* for now `wd clean` is not supported
* for now history is not supported
* for now '-' is not supported
-
-## Installation
-
-Three steps:
-
- 1. This `wd` requires version 2+ of ruby interpreter. Check your default ruby with `ruby --version`. You should see something like "ruby 2.3.0p0....". If you see version 1.9 or earlier, upgrade your ruby with `brew update; brew install ruby`.
- 2. Install warp-dir gem:
-```bash
-~ ❯ gem install warp-dir --no-ri --no-rdoc
-```
- 3. The last step is to install the `wd` BASH function and auto-completion:
-```bash
-~ ❯ warp-dir install --dotfile ~/.bash_profile
-```
-
-This last step appends the required shell function to the shell initialization file specified with the `--dotfile` flag. If you are unsure what that means, please run the command above as is.
-
-And step 3 you will need to restart your shell, so reopen your Terminal or [iTerm2](https://www.iterm2.com/) (please use iTerm over Terminal — it's soooo much better!), and then type:
-
-```bash
-~ ❯ wd help
-```
-
-If the above command returns a properly formatted help like the image below, your setup
-is now complete!
## Future Development
I have so many cool ideas about where this can go, that I created a
[dedicated page](ROADMAP.md) for the discussion of future features. Please head over