diff --git a/README.md b/README.md index 01529fe..36b77d9 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ $ unzip wakapi_linux_amd64.zip $ vi config.yml # Run it -$ ./ wakapi +$ ./wakapi ``` ### 🧑‍💻 Option 4: Run from source @@ -223,13 +223,16 @@ If you like this project, please consider supporting it 🙂. You can donate eit Since Wakapi heavily relies on the concepts provided by WakaTime, [their FAQs](https://wakatime.com/faq) apply to Wakapi for large parts as well. You might find answers there.
-What data is sent to Wakapi? -
  • File names
  • -
  • Project names
  • -
  • Editor names
  • -
  • You computer's host name
  • -
  • Timestamps for every action you take in your editor
  • -
  • ...
  • +What data is sent to Wakapi? + + See the related [WakaTime FAQ section](https://wakatime.com/faq#data-collected) for details. @@ -237,30 +240,37 @@ If you host Wakapi yourself, you have control over all your data. However, if yo
    -What happens if I'm offline? +What happens if I'm offline? + All data is cached locally on your machine and sent in batches once you're online again.
    -How did Wakapi come about? +How did Wakapi come about? + Wakapi was started when I was a student, who wanted to track detailed statistics about my coding time. Although I'm a big fan of WakaTime I didn't want to pay 9 $ a month back then. Luckily, most parts of WakaTime are open source!
    -How does Wakapi compare to WakaTime? +How does Wakapi compare to WakaTime? + Wakapi is a small subset of WakaTime and has a lot less features. Cool WakaTime features, that are missing Wakapi, include: -
  • Leaderboards
  • -
  • Embeddable Charts
  • -
  • Personal Goals
  • -
  • Team- / Organization Support
  • -
  • Integrations (with GitLab, etc.)
  • -
  • Richer API
  • + + WakaTime is worth the price. However, if you only want basic statistics and keep sovereignty over your data, you might want to go with Wakapi.
    -How are durations calculated? +How are durations calculated? + Inferring a measure for your coding time from heartbeats works a bit different than in WakaTime. While WakaTime has timeout intervals, Wakapi essentially just pads every heartbeat, that occurs after a longer pause, with 2 extra minutes. Here is an example (circles are heartbeats): @@ -273,9 +283,11 @@ Here is an example (circles are heartbeats): It is unclear how to handle the three minutes in between. Did the developer do a 3-minute break or were just no heartbeats being sent, e.g. because the developer was starring at the screen find a solution, but not actually typing code. -
  • WakaTime (with 5 min timeout): 3 min 20 sec -
  • WakaTime (with 2 min timeout): 20 sec -
  • Wakapi: 10 sec + 2 min + 10 sec = 2 min 20 sec
  • + Wakapi adds a "padding" of two minutes before the third heartbeat. This is why total times will slightly vary between Wakapi and WakaTime.