diff --git a/README.md b/README.md index c5560a2..ff9d757 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,40 @@ # Tabswiper -A Firefox extension that enhances tab switching and closing through fuzzy search. +The musthave extension for a mouse-free Firefox experience. +Switch between tabs and manage them with a fuzzy search and basic command toolset. ## How to Use It 1. Open the search page using the extension icon or by pressing `F2`. -You can customize the keyboard shortcut by accessing the `Manage Extension Shortcuts` in Firefox settings. + You can customize the keyboard shortcut by accessing the `Manage Extension Shortcuts` in Firefox settings. 1. Filter the list of open tabs with the searchbox. -1. If there is one tab left in the list, navigate to it by pressing `Enter`. +1. Switch to the top tab in search results with the `Enter` key, choose any other tab with arrow keys or press the `Tab` key to activate the actionbox. -1. Otherwise, navigate to or close the desired tab using the commandbox. +1. Press the Esc key to activate the search field or close the page if the search field is focused. + +## Availible Commands + +To invoke any of the commands, enter the command symbol and tab label, if +required, in the actionbox. For example: `fjk`, `dlum` or `S`. + +- 'f': Navigate to the labeled tab. +- 'F': Jump to the first tab in search results. +- 'd': close (*delete*) the labeled tab. +- 'D': Close the first search results tab. +- 'c': Copy (or *clone*) the labeled tab. +- 'C': Duplicate the first search results tab. +- 's': *Suspend* the labeled tab. +- 'S': Suspend all search results tabs. +- 'p': *Pin* or unpin the labeled tab. +- 'e': Move (*extract*) the tab to a popup window. +- 'q': *Quit* the search page. +- '?': Navigate to this page. + +## Keyboard Shortcut Conflict + +If the default `F2` key does not work, check for conflicts on the "Manage Extension Shortcuts" page in the drop-down menu with "Gear" icon on the "Manage Your Extensions" page (`Ctrl + Shift + A`). ## Development