From 3a15ef8ff6885277131f42c4076250cd22f40e81 Mon Sep 17 00:00:00 2001 From: alemi Date: Thu, 7 Nov 2019 06:30:14 +0100 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 074a551..ae18b4b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,17 @@ # vim-combo Have you ever wondered how sick is your function typing? That insane very long lambda you just written in one go must have been a hell of a combo, shame it wasn't tracked. -Well now you can! vim-combo is inspired by the power-mode many more graphical editors have. While all the particles and text shaking is nice and all, the thing I really wanted was to keep track of my typing combos. -So here comes vim-combo! Each keypress in insert mode increases the counter. The counter gets resetted if you type nothing for more than half a second. +Wasn't until now! vim-combo is inspired by the power-mode many more graphical editors have. While all the particles and text shaking is nice, the thing I really wanted was to keep track of my typing combos. +So here comes vim-combo! Each text edit in insert mode (autocmd on TextChangedI) increases the counter. The counter gets resetted if you type nothing for more than a second (you can set it to any number of seconds with g:timeout) -vim-combo keeps track of your best combos for each filetype. Every time vim loads, the best combo is loaded from file. Every time you get a new best score, the value on file is replaced. +Pasting counts as 1 (be it in Insert-Paste or directly from clipboard), movement does not affect the counter and backspace keeps the combo going without increasing the counter. + +vim-combo keeps track of your best combos for each filetype with files inside the hidden .combo folder (~/.vim/.combo). Every time vim loads, the best combo is loaded from file (one is kept for each filetype edited). Every time you get a new best score, the value on file is replaced. vim-combo also calculates the best combo across all filetypes, but it is not displayed by default (because my combo on .txt puts my combo on .c to shame). Use ":ComboMaxOn" and ":ComboMaxOff" to toggle. There already are few plugins which provide particles (vim-particle, vim-power-mode) but they required windows. vim-combo can run on any system since it's only vim script! + +Note that vim-combo by default places the counter in section B of airline-vim. All combos will be always tracked, but by default not displayed (as of now) unless you use airline-vim. You can add "%1*\[%{g:best_combo_all}|%{g:best_combo}\] %{g:combo_counter} ᛥ" anywhere you'd like. If you know a good spot to place it by default, do contact me! I have no idea! + +Specific filetypes can be ignored (no combo will be counted while on them, and no best combo will be recorded). By default, .cmb files won't track combo. Note that none.cmb refers to files without extension, and should be in place (because the script does not create it). + +vim-combo should be pretty fast. It runs a lot but does very little (time difference, counter). If you have any issue contact me!