aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 12 insertions, 2 deletions
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)
XMR address: 854DmXNrxULU3ZFJVs4Wc8PFhbq29RhqHhY8W6cdWrtFN3qmooKyyeYPcDzZTNRxphhJ5UzASQfAdEMwSteVqymk28aLhqj