aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 12 insertions, 7 deletions
diff --git a/README.md b/README.md
index 5759b11..1c3959f 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Watcher
+# Watcher
### Minimal Open source Screen-Time Tracker (CLI-app)
<img src="https://cdn.discordapp.com/attachments/846673042893832195/952274599276580874/watcher.png" width=90% height=auto>
@@ -9,7 +9,7 @@
- [Installation](#installation)
- [Todo](#to-do)
-## About
+## About
Watcher is CLI-app (at this moment) which helps you to get perspective about your Screen-time
## Gallery
@@ -17,14 +17,19 @@ Day Summary | Week Summary
:-------------------------:|:-------------------------:
![](https://cdn.discordapp.com/attachments/846673042893832195/952283314746691624/unknown.png) | ![](https://cdn.discordapp.com/attachments/846673042893832195/952283190716948521/unknown.png)
-Note: You might be thinking how can someone has 14hrs of screen time in a single day, Well ! short ans is AFK-feature is not implemented yet
+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
-Just clone this repo somewhere in your computer and cd into it and run install script according to your init system
-```bash
-$ bash ./install-[init-system].bash
+* Note: Install [```xdotool```](https://github.com/jordansissel/xdotool) on your system ( its the only dependancy )
+* First, Clone this repository and cd into it-
+```bash
+$ git clone https://github.com/Waishnav/Watcher
+$ cd ./Watcher/
+```
+* Then run install script
+```bash
+$ ./install
```
-for now manually add this path ```~/.local/bin/``` to your respective shell (bash, fish, zsh whatever)
## To-do
- [ ] AFK feature