From ad3e583a61d98673fd72bd93b1c5b2b3c32fbf2f Mon Sep 17 00:00:00 2001 From: Alan Hamlett Date: Tue, 29 Sep 2015 16:01:11 -0700 Subject: [PATCH] improve description in readme --- README.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 2d71763..9a8437e 100644 --- a/README.rst +++ b/README.rst @@ -7,17 +7,17 @@ WakaTime .. image:: https://coveralls.io/repos/wakatime/wakatime/badge.svg?branch=master&service=github :target: https://coveralls.io/github/wakatime/wakatime?branch=master -Fully automatic time tracking for programmers. +Command line interface to the `WakaTime `_ used by all WakaTime `text editor plugins `_. -This is the common interface for the WakaTime api. You shouldn't need to directly use this package unless you are creating a new plugin or your text editor's plugin asks you to install the wakatime cli interface. +Note: You shouldn't need to directly use this package unless you are `building your own plugin `_ or your text editor's plugin asks you to install the wakatime cli interface manually. -Go to http://wakatime.com to install the plugin for your text editor. +Go to http://wakatime.com/editors to install the plugin for your text editor or IDE. Usage ----- -Install the plugin for your IDE/editor at https://wakatime.com/plugins +Install the plugin for your IDE/editor at https://wakatime.com/editors If you are building a plugin using the `WakaTime API `_ then follow the `Creating a Plugin `_ @@ -51,7 +51,7 @@ format. An example config file looks like:: Installation ------------ -Each `plugin `_ should install wakatime for you, except for the `Emacs WakaTime plugin `_. +Each `plugin `_ should install wakatime for you, except for the `Emacs WakaTime plugin `_. If your plugin does not install wakatime cli(this package), install it with:: pip install wakatime