From d75bb50cee0d5f779ed4854110f59254d9776e6c Mon Sep 17 00:00:00 2001 From: Jack Date: Thu, 14 May 2020 19:03:05 +0100 Subject: [PATCH] readme update --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2bc0b0803..a63f953ac 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ -# monkey-type -A minimalistic typing test +# about +Monkey-type is a minimalistic typing test, featuring many test modes, an account system to save your typing speed history and user configurable features like themes, a smooth caret and more. + +# keybinds +You can use `tab` and `enter` (or just `tab` if you have quick tab mode enabled) to restart the typing test. Open the command line by pressing `esc` - there you can access all the functionality you need without touching your mouse. + +# stats +- wpm - total amount of characters in the correctly typed words, divided by 5 +- acc - percentage of correctly pressed keys +- key - correct characters / incorrect characters. Calculated after the test has ended + +# bug report or feature request +If you encounter a bug, or have a feature request - send me a message on Reddit, create an issue on GitHub or send me a message using the command line `esc`. + +# credits +montydrei for the name suggestion +everyone who provided valuable feedback on the original reddit post for the prototype of this website