Skip to content

Commit

Permalink
Installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Joel Kemp committed Jun 17, 2014
1 parent f7e549d commit b9e3a5a
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,20 @@ You need to have Node.js installed and [node-dependents](https://github.com/mrjo

`npm install node-dependents`

### Usage
### Installation

Install `Dependents` via Package Control.

Don't see it? Add the repository and install it:

1. Package Control -> Add Repository
2. Enter `https://github.com/mrjoelkemp/sublime-dependents`
3. Package Control -> Install Package
4. Choose sublime-dependents

##### Key binding
Finally, add the key binding definition below and you're all set!

#### Key binding

You need to supply the plugin with a `root` which dictates where to look for dependents.
This value is then sent to [node-dependents](https://github.com/mrjoelkemp/node-dependents).
Expand All @@ -36,7 +47,9 @@ Add the following to your User defined keyboard bindings: `Preferences` -> `Key

```

Use `cmd + option + up` to trigger finding the dependents.
### Usage

Use the `keys` value above, `cmd + option + up`, to trigger finding the dependents.

* If dependents are found, you'll see them in a quick panel (i.e., dropdown).
* You can select any of the items in the panel to jump to that file
Expand Down

0 comments on commit b9e3a5a

Please sign in to comment.