From 8171795725a4ac736a55183870837237b50d8640 Mon Sep 17 00:00:00 2001 From: Ross Hemsley Date: Sun, 6 Dec 2015 11:41:14 +0000 Subject: [PATCH] Update readme --- README.md | 37 ++++++++++++++----------------------- 1 file changed, 14 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index ebbb919..5cf8318 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,30 @@ iOpener ======= -A Sublime Text 3 package to make locating and opening files much faster, by -opening from path instead of using the gui interface. Behaviour mostly emulates -emacs' find-file. With auto-completion, directory listings and history. +A Sublime Text 2/3 package to make finding and opening files less painful. +Keep your hands on the keyboard with smart auto completion, history, and directory listings. -Use ---- -Tap `super+o` or `cntl-o` as usual (or use the command pallete, and select the -command `Find File`). You will be greeted with an input panel that allows you to -type in file paths. +Usage +----- +Use `cmd + o` or `cntl + o` as usual (or choose `Find File` in the command pallete.) -- Pressing tab will cause completion to occur. +- Pressing tab will cause smart completion to occur (hint: `f1` can complete to `filename1`!) -- Double-tapping tab will allow you to search a current directory. +- Double-pressing tab will give you the directory listing -- Up/down allow you to navigate history. +- Up/down allow you to navigate previously entered paths -- Attempting to open a path that doesn't exist will give a message asking - whether or not to create the path. +- Opening a path that doesn't exist will create a new file or directory ![demo](https://raw.github.com/rosshemsley/iOpener/screenshots/demo.gif) -Note ----- -- This plugin will take over your default 'open file' shortcut. If you want to - use your system file-open dialog, use `super+shift+o` or `ctrl+shift+o` - depending on your OS. +NB +-- +- This plugin will take over your default 'open file' shortcut. To + use your system default, use `cmd + shift + o` or `ctrl + shift + o` - The open panel will not show unless a window is open. You will need to use - `cntl+n` or `super+n` to open a new window first. + `cntl + n` or `cmd + n` to open a new window first Installing @@ -37,10 +32,6 @@ Installing Installation is easiest using Package Control. In the Command Pallette, select "Install Package" and then select "iOpener". -Credits -------- -I looked at lots of other people's code to write this, including in particular -SublimeMRU and FuzzyFileNav. Thanks for your inspiration! Bugs ----