aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 29 insertions, 2 deletions
diff --git a/README.md b/README.md
index 83e69a6..9c700c5 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,29 @@
-# Watcher
-Minimal Open source Screen-Time calculator
+# 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)
+- [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
+:-------------------------:|:-------------------------:
+![](https://cdn.discordapp.com/attachments/846673042893832195/952283314746691624/unknown.png) | ![](https://cdn.discordapp.com/attachments/846673042893832195/952283190716948521/unknown.png)
+## Info
+
+## Installation
+Just clone this repo somewhere in your computer and cd into it and run install script
+```bash
+$ bash ./install.bash
+```
+
+## To-do
+- [ ] AFK feature
+- [ ] GUI only if got 300 stars Probably [Tauri App](https://github.com/tauri-apps/tauri).