From 6a79a978dd25b02bdbc51a845d7dcfbdcec6798b Mon Sep 17 00:00:00 2001
From: Pazl <130466427+Pazl27@users.noreply.github.com>
Date: Thu, 6 Aug 2026 18:10:18 +0200
Subject: [PATCH 1/2] docs: updated readme with new text + images
---
README.md | 139 ++++++++++++++-----
docs/assets/2025-02-11 00-03-13.mkv | Bin 12157479 -> 0 bytes
docs/assets/coding.png | Bin 0 -> 809829 bytes
docs/assets/demo.gif | Bin 854781 -> 0 bytes
docs/assets/home.png | Bin 0 -> 766470 bytes
docs/assets/performance.png | Bin 0 -> 763754 bytes
docs/assets/settings.png | Bin 0 -> 794807 bytes
docs/assets/snapshot_2025-02-24_00-28-16.png | Bin 61752 -> 0 bytes
docs/assets/stats.png | Bin 0 -> 771199 bytes
docs/assets/typing.png | Bin 0 -> 794532 bytes
10 files changed, 101 insertions(+), 38 deletions(-)
delete mode 100644 docs/assets/2025-02-11 00-03-13.mkv
create mode 100644 docs/assets/coding.png
delete mode 100644 docs/assets/demo.gif
create mode 100644 docs/assets/home.png
create mode 100644 docs/assets/performance.png
create mode 100644 docs/assets/settings.png
delete mode 100644 docs/assets/snapshot_2025-02-24_00-28-16.png
create mode 100644 docs/assets/stats.png
create mode 100644 docs/assets/typing.png
diff --git a/README.md b/README.md
index ff9eab1..e13625d 100644
--- a/README.md
+++ b/README.md
@@ -6,13 +6,25 @@
| | | | | | --' | |
`--' `--' `--' `--'
+
+ A Monkeytype-style typing test for your terminal.
+
+ Type words or real code, watch your WPM, and pick a theme you like. Built with
+ ratatui.
+
+
+
+
-> [!WARNING]
-> When the terminal is too small it can lead to strange behavior.
+
+
+> [!WARNING]
+> When the terminal is too small it can lead to strange behavior. Give it some room.
## Table of contents
- [Overview](#overview)
+- [Modes](#modes)
- [Installation](#installation)
- [Usage](#usage)
- [Keybindings](#keybindings)
@@ -25,22 +37,48 @@
- [Uninstall](#uninstall)
## Overview
-
-
-I wanted a simple typing game to improve my typing speed and accuracy. I really like using
-[monkeytype](https://monkeytype.com/), so I built something similar for the terminal. Typy is a
-terminal typing test built with [ratatui](https://ratatui.rs/): it shows a stream of random words,
-tracks your speed and accuracy, and plots your words-per-minute over the run.
-The app is fully interactive:
+I wanted a simple typing game to improve my speed and accuracy. I'm a fan of
+[monkeytype](https://monkeytype.com/), so I built something similar for the terminal. Typy throws a
+stream of random words at you (or a real code snippet), keeps track of your speed and accuracy, and
+draws a little graph of your WPM at the end.
+
+Later on I added the code mode for a more selfish reason: I was learning a new keyboard layout and
+switching to a Corne keyboard, and typing prose gets you comfortable but it doesn't really
+prepare you for code. All the brackets, symbols and indentation are exactly the parts that trip you
+up on a new layout, so being able to drill on actual snippets made the transition a lot less painful.
+If you're in the same boat, that's what code mode is for.
+
+You don't have to remember any flags, run `typy` and everything (mode, theme, language, modifiers)
+lives on the settings screen.
+
+## Modes
+
+
|
+ Words + Random words in whatever language you pick. Turn on punctuation, numbers or uppercase when you + want it a bit harder. + |
+
+ Code + Real code snippets from open-source projects, highlighted with tree-sitter. Each one links back + to where it came from. Great for getting used to symbols and indentation on a new layout or + keyboard. + |
+
![]() |
+ ![]() |
+
+
+
+1Hb@@*ix!R{@Y;SL-m|6Ue=KS{ZNQHzT
z?cIHvmr7ieTvr-|ern!d68|BRcQ4)1eLHPi#hO!ZdL;(F*E#8RDKe4KF}fgX^AGb!
z1 T?{F0K)I9#}{? &7CD0lVRON3+c5j@CjSquem8#gV8YHv=dmJq3+2KK?LEa1A3Fj*A$_+I~ax
zU^4RQ3oBoRU=k;p%AW^hpA?c)LpGm%5c%dO&F0oFj%6B7Fq7le)FRQc{`q-8kteP+
z$7Rl8gYvKV=C_1(pSZ+Z?QuVm-|Swx@Y1l?jLnsqjf(#1Q(a-%Z*q2mUusm@Sld=L
zdkJ)yKXJv#5#6K7_wK)1F?Q#rc6#@Xq(Qn;S3-+c@8-PBA6>a3LUc5D|yujgJEh2_a$$r;Yb!)RMkjcx-V`p2ZN-{HWtqrpu