aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2018-03-26 19:49:34 +0200
committerTeddy Wing2018-03-26 19:49:34 +0200
commitff730bc45304726dc1edba6ed649ba14aef4398a (patch)
tree4804822858a6e05900aef4c5dd5cda8e6a58e3a6
parent3924da0b5220f75b0fd511997947032fee90dbad (diff)
downloadQWAZERTY-ff730bc45304726dc1edba6ed649ba14aef4398a.tar.bz2
README: Add a section for example usage with .vimrc mappings
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2c807fd..fe5e62c 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,14 @@ access to functionality with a single button press.
## Screenshots
+## Example Usage
+Here is an extract from my `.vimrc`, which adds bindings to run Ruby tests when
+the special emoji key is pressed:
+
+ nnoremap 🕳 :call RunCurrentSpecFile()
+ nnoremap ⛳ :call RunNearestSpec()
+
+
## Install