diff --git a/README.rst b/README.rst index 08393f4..02dfb02 100644 --- a/README.rst +++ b/README.rst @@ -3,6 +3,10 @@ rana-cli Command line interface to `rana `_. +This is a fork of the wakatime CLI tool for use with rana. + +Rana is not affiliated with WakaTime. + Go to http://gitdab.com/lavatech to install the plugin for your text editor or IDE. @@ -35,6 +39,8 @@ Some more usage information is available in the `FAQ ` Configuring ----------- +`The only modification from a original config file is the api_key field` + Options can be passed via command line, or set in the ``$WAKATIME_HOME/.wakatime.cfg`` config file. Command line arguments take precedence over config file settings. The ``$WAKATIME_HOME/.wakatime.cfg`` file is in `INI `_ @@ -43,6 +49,7 @@ format. An example config file with all available options:: [settings] debug = false api_key = your-api-key + base_url = https://your-rana-instance.com hide_file_names = false hide_project_names = false exclude =