From c96432779a0b68effdd211931c13bcbcf2091f54 Mon Sep 17 00:00:00 2001
From: Jens Krause <47693+sectore@users.noreply.github.com>
Date: Wed, 30 Apr 2025 14:19:13 +0200
Subject: [PATCH] (readme) add keybindings + toc (#78)

* (readme) add keybindings + toc
* update LICENSE
---
 LICENSE   |  2 +-
 README.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 73 insertions(+), 3 deletions(-)

diff --git a/LICENSE b/LICENSE
index cb22943..abe4564 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Jens K.
+Copyright (c) 2024-2025 Jens Krause
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
index cd5dba7..14c72e9 100644
--- a/README.md
+++ b/README.md
@@ -8,9 +8,20 @@ TUI to organize your time: Pomodoro, Countdown, Timer.
 
 Built with [Ratatui](https://ratatui.rs/) / [Rust 🦀](https://www.rust-lang.org/).
 
-# Features
 
-_Side note:_ Theme colors depend on your terminal preferences.
+# Table of Contents
+
+- [Preview](./#preview)
+- [CLI](./#cli)
+- [Keybindings](./#keybindings)
+- [Installation](./#installation)
+- [Development](./#development)
+- [Misc](./#misc)
+- [License](./#license)
+
+# Preview
+
+_(theme depends on your terminal preferences)_
 
 ## Pomodoro
 
@@ -89,6 +100,61 @@ Extra option (if `--features sound` is enabled by local build only):
 --sound <SOUND>                Path to sound file (.mp3 or .wav) to play as notification. Experimental.
 ```
 
+# Keybindings
+
+## Menu
+
+| Key | Description |
+| --- | --- |
+| <kbd>↑</kbd> / <kbd>↓</kbd> or <kbd>m</kbd> | Toggle menu |
+
+## Screens
+
+| Key | Description |
+| --- | --- |
+| <kbd>p</kbd> | Pomodoro |
+| <kbd>c</kbd> | Countdown |
+| <kbd>t</kbd> | Timer |
+
+## Controls
+
+| Key | Description |
+| --- | --- |
+| <kbd>s</kbd> | start |
+| <kbd>r</kbd> | reset |
+| <kbd>e</kbd> | enter edit mode |
+| <kbd>q</kbd> | quit |
+
+**In `edit` mode only:**
+
+| Key | Description |
+| --- | --- |
+| <kbd>Enter</kbd> | apply changes |
+| <kbd>Esc</kbd> | skip changes |
+| <kbd>←</kbd> or <kbd>→</kbd> | change selection |
+| <kbd>↑</kbd> or <kbd>↓</kbd> | change values to go up or down |
+
+**In `Pomodoro` screen only**
+
+| Key | Description |
+| --- | --- |
+| <kbd>←</kbd> or <kbd>→</kbd> | switch work/pause |
+| <kbd>^r</kbd> | reset round |
+
+**In `Countdown` screen only:**
+
+| Key | Description |
+| --- | --- |
+| <kbd>^e</kbd> | edit by local time |
+
+## Appearance
+
+| Key | Description |
+| --- | --- |
+| <kbd>,</kbd> | toggle styles |
+| <kbd>.</kbd> | toggle deciseconds |
+| <kbd>:</kbd> | toggle local time in footer |
+
 # Installation
 
 ## Cargo
@@ -224,3 +290,7 @@ C:/Users/{user}/AppData/Local/timr-tui/logs/app.log
 ```
 
 Optional: You can use a custom directory by passing it via `--log` arg.
+
+# License
+
+[MIT License](./LICENSE)