From 74ef082213655c47cd7d7b35313d4c0a10af8a83 Mon Sep 17 00:00:00 2001 From: Alan Hamlett Date: Wed, 24 May 2017 06:39:56 -0700 Subject: [PATCH] improve config section --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9638a8f..8072dac 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,27 @@ Screen Shots Configuring ----------- -To use a custom python binary: +#### Custom Commands: + +* `:WakaTimeApiKey` - change the api key saved in your `~/.wakatime.cfg` +* `:WakaTimeDebugEnable` - enable debug mode (may slow down Vim so disable when finished debugging) +* `:WakaTimeDebugDisable` - disable debug mode +* `:WakaTimeScreenRedrawEnable` - temporarily enable screen redraw to prevent artifacts +* `:WakaTimeScreenRedrawDisable` - disable screen redraw for performance + +#### Vimrc Settings: let g:wakatime_PythonBinary = '/usr/bin/python' +Tells the plugin to use a custom python binary. The default is to use `python` from your system PATH. -WakaTime plugins share a common config file `~/.wakatime.cfg` located in your user home directory with [these options][wakatime-cli-config] available. + let g:wakatime_ScreenRedraw = 1 + +Enables redrawing the screen after sending heartbeats, to prevent screen artifacts in case a key was pressed while the plugin executed. + + +WakaTime plugins share a common config file located in your user home folder at `~/.wakatime.cfg` with [common plugin settings][wakatime-cli-config]. Troubleshooting