diff --git a/README.md b/README.md index 7f7ceec..97c5db1 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ __Spatial Navigation Chrome Extension__ Smart spatial navigation with key map to links. -This is based off the *Spatial Navigation* extension by Falsandtru:\ +Based off the *Spatial Navigation* extension by Falsandtru:\ https://github.com/falsandtru/spatial-navigation -Binds WASD, F, E and Q keys for navigation/hints. +Binds WASD, F, E and Q keys for navigation/hints mode. * `W/A/S/D`: Four-way spatial navigation * `E/Shift+E`: Expand/Contract (change link targets) @@ -15,10 +15,12 @@ Binds WASD, F, E and Q keys for navigation/hints. * `Enter/F`: Click link * `Shift+Enter/Shift+F`: Shift-click link (open new tab) * `Ctrl+Enter/Ctrl+F`: Ctrl-click link (open new background tab) -* `Ctrl+Shift+X`: Disable the hotkeys (for current tab) +* `Ctrl+Shift+X`: Disable the hotkeys for current tab Set your own keys: Click the icon and choose Options, or visit the details page in the browser extension manager. +Any contributions are most welcome! 🤓👍 + ### Screenshot ![Screenshot of extension in use](https://raw.githubusercontent.com/Pathduck/spatialnavigation/main/img/screenshot.jpg "Screenshot of extension in use") @@ -31,24 +33,24 @@ As this started as a very personal extension for my use, some things are the way Here are some of the more common issues/bugs/TODOs and some tips: +* Changing keys in options require a tab reload to take effect. + * Using `Ctrl+` in hints mode does not work. Using `Shift+` works for opening in a new tab though. -* The default Ctrl+click key interferes with the common shortcut `Ctrl+F` for Find.\ -I suggest using something else for Find, like F3, or changing the key to for instance `G`. +* The default `Ctrl+F` interferes with the common browser shortcut for Find-In-Page. I suggest using something else for Find, like F3, or changing the key to for instance `G`. -* Even if keys are changed, there might be conflict issues with the link hints, see below. +* Even if keys are changed, there might be conflicts with the link hints as they are hord-coded, see below. -* The extension uses a hard-coded list of link hint keys. These might interfere with common browser keys,especially if single-key shortcuts are used in the browser. If so these will need to be removed from the list. +* The extension uses a hard-coded list of link hint keys. These might interfere with common browser keys, especially if single-key shortcuts are used in the browser. If so these will need to be removed from the list. -* The list of available link hint keys are in `js/spatial-navigation.js`:\ +* The list of available link hint keys are in `spatial-navigation.js`:\ `var keys = 'abcdfghijklmnoprstuvwxyz'`\ You can edit this string and reload the extension. You can also add keys you want to use instead, for instance the number keys (if not used for anything else). -* The CSS styles for links/hints/url display can if necessary be changed by editing the following values in `js/spatial-navigation.js`:\ +* The CSS styles for links/hints/url display can if necessary be changed by editing the following values in `spatial-navigation.js`:\ `this.style.innerHTML`\ `marker.style.cssText`\ `display.style.cssText` * There are no language options or internationalization. -Any contributions are most welcome! 🤓👍