sublime-wakatime/README.md

sublime-wakatime
================

Sublime Text 2 & 3 plugin to quantify your coding using https://wakatime.com/.

Installation
------------

Heads Up! For Sublime Text 2 on Windows & Linux, WakaTime depends on [Python](http://www.python.org/getit/) being installed to work correctly.
    
1. Install [Package Control](https://packagecontrol.io/installation).

2. Using [Package Control](https://packagecontrol.io/docs/usage):

  a) Inside Sublime, press `ctrl+shift+p`(Windows, Linux) or `cmd+shift+p`(OS X).

  b) Type `install`, then press `enter` with `Package Control: Install Package` selected.

  c) Type `wakatime`, then press `enter` with the `WakaTime` plugin selected.

3. Enter your [api key](https://wakatime.com/settings#apikey), then press `enter`.

4. Use Sublime and your time will be tracked for you automatically.

5. Visit https://wakatime.com/dashboard to see your logged time.

Screen Shots
------------

![Project Overview](https://wakatime.com/static/img/ScreenShots/ScreenShot-2014-10-29.png)

Troubleshooting
---------------

First, turn on debug mode in your `WakaTime.sublime-settings` file.

![sublime user settings](https://wakatime.com/static/img/ScreenShots/sublime-wakatime-settings-menu.png)

Add the line: `"debug": true`

Then, open your Sublime Console with `View -> Show Console` to see the plugin executing the wakatime cli process when sending a heartbeat. Also, tail your `$HOME/.wakatime.log` file to debug wakatime cli problems.

For more general troubleshooting information, see [wakatime/wakatime#troubleshooting](https://github.com/wakatime/wakatime#troubleshooting).
updated wakatime.py package. using new usage logic for better actions accuracy. 2013-07-10 11:14:44 +04:00			`sublime-wakatime`
Initial commit 2013-07-02 09:43:12 +04:00			`================`

update project description 2015-09-26 21:51:19 +03:00			`Sublime Text 2 & 3 plugin to quantify your coding using https://wakatime.com/.`
initial commit 2013-07-02 13:21:13 +04:00
			`Installation`
			`------------`

updated heads up message about python requirement in readme 2013-08-08 14:13:19 +04:00			`Heads Up! For Sublime Text 2 on Windows & Linux, WakaTime depends on [Python](http://www.python.org/getit/) being installed to work correctly.`
improve install instructions 2014-11-06 12:47:42 +03:00
update name of Package Control 2015-01-07 01:07:55 +03:00			`1. Install [Package Control](https://packagecontrol.io/installation).`
initial commit 2013-07-02 13:21:13 +04:00
update name of Package Control 2015-01-07 01:07:55 +03:00			`2. Using [Package Control](https://packagecontrol.io/docs/usage):`
initial commit 2013-07-02 13:21:13 +04:00
improve install instructions 2014-11-06 12:47:42 +03:00			a) Inside Sublime, press `ctrl+shift+p`(Windows, Linux) or `cmd+shift+p`(OS X).
initial commit 2013-07-02 13:21:13 +04:00
updated readme 2013-07-11 07:24:39 +04:00			b) Type `install`, then press `enter` with `Package Control: Install Package` selected.
prompting user for api key if does not exist. updated readme with install instructions using Sublime Package Control. 2013-07-11 06:01:06 +04:00
updated readme 2013-07-11 07:24:39 +04:00			c) Type `wakatime`, then press `enter` with the `WakaTime` plugin selected.
formatted readme 2013-07-11 06:04:46 +04:00
improve install instructions 2015-04-10 05:08:29 +03:00			3. Enter your [api key](https://wakatime.com/settings#apikey), then press `enter`.
initial commit 2013-07-02 13:21:13 +04:00
improve install instructions 2014-11-06 12:47:42 +03:00			`4. Use Sublime and your time will be tracked for you automatically.`
initial commit 2013-07-02 13:21:13 +04:00
improve install instructions 2014-11-06 12:47:42 +03:00			`5. Visit https://wakatime.com/dashboard to see your logged time.`
added install instructions for BIND9 2013-07-11 07:53:28 +04:00
initial commit 2013-07-02 13:21:13 +04:00			`Screen Shots`
			`------------`

update screen shot to new dashboard 2014-11-06 12:48:52 +03:00			`![Project Overview](https://wakatime.com/static/img/ScreenShots/ScreenShot-2014-10-29.png)`
initial commit 2013-07-02 13:21:13 +04:00
troubleshooting section in readme 2015-07-15 23:44:07 +03:00			`Troubleshooting`
			`---------------`

			First, turn on debug mode in your `WakaTime.sublime-settings` file.

			`![sublime user settings](https://wakatime.com/static/img/ScreenShots/sublime-wakatime-settings-menu.png)`

			Add the line: `"debug": true`

			Then, open your Sublime Console with `View -> Show Console` to see the plugin executing the wakatime cli process when sending a heartbeat. Also, tail your `$HOME/.wakatime.log` file to debug wakatime cli problems.

link to wakatime/wakatime#troubleshooting 2015-07-15 23:46:26 +03:00			`For more general troubleshooting information, see [wakatime/wakatime#troubleshooting](https://github.com/wakatime/wakatime#troubleshooting).`