diff options
| -rw-r--r-- | README.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..244e822 --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# Watcher + +### Minimal Open source Screen-Time Tracker (CLI-app) + +<img src="https://cdn.discordapp.com/attachments/846673042893832195/952274599276580874/watcher.png" width=90% height=auto> + +## Table of Contents + +- [About](#about) +- [Gallery](#gallery) +- [Installation](#installation) +- [Want to Contribute](#want-to-contribute) +- [Todo](#to-do) + + +## About + +Watcher is CLI-app (at this moment) which helps you to get perspective about your Screen-time + +## Gallery + +| Day Summary | Week Summary | +| :-------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------: | +|  |  | + +Funfact: You might be thinking how can someone has 14 hrs of screen time in a single day, Well ! short ans is AFK-feature is not implemented yet... Most of the time I left my laptop as it is so it also counts that AFK time as Screen-time + +## Installation + +- Note: Install [`xprintidle`](https://github.com/g0hl1n/xprintidle) and [`xdotool`](https://github.com/jordansissel/xdotool) on your system ( the only dependancies other than python3 ). Install [`python3`](https://www.python.org/downloads/) if not installed in your machine. +- First, Install the following dependancy `xprintidle` and `xdotool` + +```bash +$ sudo [package-manager] install xprintidle xdotool +``` + +- Second, Clone this repository and cd into it- + +```bash +$ git clone https://github.com/Waishnav/Watcher +$ cd ./Watcher/ +``` + +- Then run install script + +```bash +$ chmod +x ./install && ./install +``` + +### Want to Contribute +If you are interseted in contibuting checkout [CONTRIBUTING.md](https://github.com/Waishnav/Watcher/blob/main/CONTRIBUTING.md) + +You can currently contribute to one of the three projects listed below throughout the HACTOBERFEST. +- [Watcher Website](https://github.com/Waishnav/Watcher-web) (made with React) +- [Watcher v1.0](https://github.com/Waishnav/Watcher/tree/v1.0) (No real time updates in logfile) +- [Watcher v2.0](https://github.com/Waishnav/Watcher/tree/v2.0) (Real time stats in logfile) + +To contribute, clone the relevant branch anywhere you wish to. + +## To-do + +- [x] AFK feature +- [ ] GUI only if got 300 stars Probably [Tauri App](https://github.com/tauri-apps/tauri). |