Skip to content

Commit 3b48e92

Browse files
committed
docs: update README to clarify logging features and add installation instructions
1 parent aa54c07 commit 3b48e92

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
# work_log
22

3-
Log the active window and cursor position to a CSV file.
3+
Log the active window (title + app name) and cursor position to a CSV file.
4+
Only if the window and/or cursor position changes, a new line is added.
5+
6+
This can be used to analyze how you spend your tiMyOrg.tld on your computer.
7+
8+
Supported platforms:
9+
- Windows
10+
- Linux
11+
- MacOS
12+
13+
## Install
414

5-
This can be used to analyze how you spend your time on your computer.
15+
Download the latest release for your platform from the [releases page](https://github.com/daniel-sc/work_log/releases).
616

717

818
## Usage
@@ -19,4 +29,28 @@ Options:
1929
(options are preserved, do not move the executable afterwards)
2030
--autostart-remove remove the program from startup
2131
--help display this help and exit
32+
```
33+
34+
## Example
35+
36+
The resulting csv file will look like this:
37+
38+
```csv
39+
2025-02-10T14:11:27.280560100+01:00,IntelliJ IDEA Ultimate Edition,my-project – my-project-api.yaml [my-project-specs],1859,-265
40+
2025-02-10T14:11:29.282786900+01:00,IntelliJ IDEA Ultimate Edition,my-project – my-project-api.yaml [my-project-specs],2797,-256
41+
2025-02-10T14:11:31.284762600+01:00,IntelliJ IDEA Ultimate Edition,my-project – my-project-api.yaml [my-project-specs],2785,-269
42+
2025-02-10T14:11:47.297288500+01:00,IntelliJ IDEA Ultimate Edition,my-project – my-project-api.yaml [my-project-specs],1187,342
43+
2025-02-10T14:11:49.299215900+01:00,IntelliJ IDEA Ultimate Edition,my-project – my-project-api.yaml [my-project-specs],1137,294
44+
2025-02-10T14:11:51.301234900+01:00,Microsoft Teams,Chat | My Collegue | MyOrg | me@MyOrg.tld | Microsoft Teams,2500,773
45+
2025-02-10T14:11:53.302912900+01:00,Google ChroMyOrg.tld,fix: remove redundant dependency installation step in release workflow · daniel-sc/work_log@7913ec1 - Google ChroMyOrg.tld,2627,-621
46+
2025-02-10T14:11:55.304411900+01:00,Google ChroMyOrg.tld,some-Details-CSV.xlsx - Google ChroMyOrg.tld,2627,-393
47+
2025-02-10T14:11:57.305902500+01:00,Google ChroMyOrg.tld,some-Details-CSV.xlsx - Google ChroMyOrg.tld,2425,-246
48+
2025-02-10T14:11:59.308051200+01:00,Google ChroMyOrg.tld,some-Details-CSV.xlsx - Google ChroMyOrg.tld,4006,-659
49+
2025-02-10T14:12:01.310655400+01:00,Microsoft Teams,Chat | My Collegue | MyOrg | me@MyOrg.tld | Microsoft Teams,3981,-653
50+
2025-02-10T14:12:03.313292200+01:00,Microsoft Teams,Chat | My Collegue | MyOrg | me@MyOrg.tld | Microsoft Teams,206,166
51+
2025-02-10T14:12:05.315070100+01:00,Microsoft Teams,Chat | My Collegue | MyOrg | me@MyOrg.tld | Microsoft Teams,826,752
52+
2025-02-10T14:12:07.317465200+01:00,Microsoft Teams,Chat | My Collegue | MyOrg | me@MyOrg.tld | Microsoft Teams,855,725
53+
2025-02-10T14:12:13.323934400+01:00,IntelliJ IDEA Ultimate Edition,my-project – my-project-api.yaml [my-project-specs],2199,-42
54+
2025-02-10T14:12:15.326757500+01:00,Microsoft Teams,Chat | My Collegue | MyOrg | me@MyOrg.tld | Microsoft Teams,973,702
55+
2025-02-10T14:12:19.330715500+01:00,Microsoft Teams,Chat | My Collegue | MyOrg | me@MyOrg.tld | Microsoft Teams,1161,441
2256
```

0 commit comments

Comments
 (0)