Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

added some usage tips

  • Loading branch information...
commit 18eea254f469eef84948b8f4b3c4819a68af1d46 1 parent b8e6b99
@thricedotted authored
Showing with 13 additions and 6 deletions.
  1. +13 −6 README.md
View
19 README.md
@@ -3,6 +3,8 @@ Vimflowy: Vim shortcuts for Workflowy
Vimflowy is a Google Chrom{e,ium} extension that brings the goodness of (super-basic) Vim navigation into the wonderful online listiness of Workflowy! It does not do anything fancy, it just provides some convenient Workflowy key bindings that might be more convenient to people who have Vim built into their motor system. It exists because I found myself typing `jjjjj` and/or ending up in the search box after pressing `<Esc>` one too many times.
+If you like Vimflowy, please let me know! I'm curious to see how "niche" this actually is. :)
+
Keybindings
-----------
@@ -15,7 +17,6 @@ Keybindings
- `l`: Move cursor right
- `w`: Move one word forward
- `b`: Move one work back
-
* Insertion
- `i`: Enter Insert mode
- `a`: Enter Insert mode (same as `i` for now)
@@ -23,7 +24,6 @@ Keybindings
- `o`: Create a new bullet point after current item and enter Insert mode
- `I`: Enter Insert mode at beginning of line
- `A`: Enter Insert mode at end of line
-
* Other
- `x`: Delete character before cursor
- `u`: Undo
@@ -32,11 +32,11 @@ Keybindings
### Insert mode ###
* `<Esc>`: Enter Normal mode
+* More soon, hopefully!
### Extra shortcuts ###
-Vimflowy also adds some extra key bindings for common Workflowy tasks that
-work in both normal and insert modes.
+Vimflowy also adds some extra key bindings for common Workflowy tasks that work in both normal and insert modes. Other than `<Esc>` to search, all of Workflowy's built-in shortcuts are still available as well.
* `<Alt>l`: Zoom into current list item
* `<Alt>h`: Zoom out of current list
@@ -45,11 +45,18 @@ work in both normal and insert modes.
* `<Alt><Shift>k`: Move current item up
* `<Alt><Shift>j`: Move current item down
+Usage tips
+----------
+
+If you're using [Vimium](http://vimium.github.com/) (or any other Chrome extensions that install modal keybindings), make sure you add `http*://*.workflowy.com/*`to the excluded URLs.
+
+Personally, I like to run Workflowy in Chromium's app mode: i.e. `chromium --app="https://workflowy.com"`.
+
Known bugs
----------
-AKA things I hope I can fix soon, or things that anyone else is welcome to
-fix!
+AKA things I hope I can fix soon, or things that anyone else is welcome to fix!
* Chrome keybindings (e.g., close/open tab) don't work in Normal mode.
* There is currently no search shortcut.
+* Support for key sequences would be pretty sweet, but I still need to work out conflicts with other bindings.
Please sign in to comment.
Something went wrong with that request. Please try again.