README.md

   1 # VimFx - Vim keyboard shortcuts for Firefox
   2
   3 VimFx is a [Mozilla Firefox](https://www.mozilla.org/en-US/firefox/fx/#desktop)
   4 extension which introduces Vim-style keyboard shortcuts for browsing and navigation,
   5 significantly reducing the use of mouse, and allowing your hands to rest on the home row.
   6
   7 VimFx was designed after [Vimium](http://vimium.github.com/) for
   8 [Google Chrome](https://www.google.com/intl/en/chrome/browser/) preserving the shortcuts and behavior.
   9 If your are used to Vimium then it will be easy to get started with VimFx.
  10
  11 ## Why VimFx was created
  12
  13 Even before Vimium there was [Vimperator](http://www.vimperator.org/) for Firefox.
  14 The problem with Vimperator is that it has too many features and aggressively
  15 change the default Firefox appearance and behavior. Vimium was developed for Google Chrome
  16 and it was exactly what I needed in terms of added functionality. That's why I decided
  17 to develop similar extension for Firefox.
  18
  19 VimFx will be nice to your browser and to your habits.  Promise.
  20
  21 ## Key Features
  22
  23 - Concise shortcuts for most commonly performed actions
  24 - Easily follow links and access controls on the page using hint markers
  25 - Easy access to the Help page which describes all available shortcuts
  26
  27 ## Shortcuts
  28
  29 Might not be up to date. Please refer to the Help dialog withing the extension
  30 for the most relevant list.
  31
  32 ### URLs
  33
  34     p       Navigate to the address in the clipboard
  35     P       Open new tab and navigate to the address in the clipboard
  36     yf      Copy link url to the clipboard
  37     yy      Copy current page link to the clipboard
  38     r       Reload current page
  39     R       Reload current page and all the assets (js, css, etc.)
  40
  41 ### Navigating
  42
  43     gg      Scroll to the Top of the page
  44     G       Scroll to the Bottom of the page
  45     j c-e   Scroll Left
  46     k c-y   Scroll Right
  47     h       Scroll Down
  48     l       Scroll Up
  49     d c-d   Scroll a Page Down
  50     u c-u   Scroll a Page Up
  51
  52 ### Tabs
  53
  54     t       Open New Blank tab
  55     J gT    Go to the Previous tab
  56     K gt    Go to the Next tab
  57     gH g0   Go to the First tab
  58     gL g$   Go to the Last tab
  59     x       Close current tab
  60     X       Restore last closed tab
  61
  62 ### Browsing
  63
  64     f       Follow a link on the current page
  65     F       Follow a link on the current page in a new tab
  66     H       Go Back in history
  67     L       Go Forward in history
  68
  69 ### Misc
  70
  71     ?       Show Help Dialog
  72     Esc     Close this dialog and cancel hint markers
  73
  74 ## Release Notes
  75
  76 0.1 (26 Oct 2012)
  77
  78 - Initial Release