From f58a40d57e894f7e49b196bceb16be2c0460605a Mon Sep 17 00:00:00 2001 From: Mroik Date: Sun, 2 Feb 2025 05:12:17 +0100 Subject: Add example to README --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 329ac85..05d7f6c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ -A typing program kinda like monkeytype.com but in your terminal! Just run it -specifying the text to use with `--quote`. +# Marika Finger Blaster +A typing program kinda like monkeytype.com but in your terminal! +There's only one argument you have to use which is the path to a file containing +the text you want to use. +![gif showing how it works](https://raw.githubusercontent.com/Mroik/marika-finger-blaster/refs/heads/master/assets/example.gif) + +At the end it shows your: +- WPM +- Amount of mistakes +- Accuracy. +It even has a mistake history highlighting where were your mistakes. +(Sorry for the font of my terminal :P) -- cgit v1.3