From b9e3a5aa1e12be53e0a036092517ea2de09a4b30 Mon Sep 17 00:00:00 2001 From: Joel Kemp Date: Tue, 17 Jun 2014 10:54:13 -0400 Subject: [PATCH] Installation instructions --- readme.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 19a2c409..997ef111 100644 --- a/readme.md +++ b/readme.md @@ -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). @@ -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