Skip to content

Commit

Permalink
chore: adjust features in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
viliusddd committed Jun 5, 2024
1 parent dff1874 commit 3b03603
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@ Discover the dark art of typing without looking, transforming your clumsy keystr
- [Setup](#setup)

## Features
- Countdown starts with the press of any key;
- Press `Enter` to restart with the same text or `Esc`/"Restart" button to restart with the change of the text;
- **WPM** and **Accuracy** stats are shown "real-time", i.e. are updated every second;
- At the end of each session chart shows up where it shows the game-play history of up to 20 sessions back. More details can be seen hovering mouse on each session indicator circle:
* date and time test was taken;
* WPM - words per minute;
* accuracy - percentage of correct words;
* correct words count;
* wrong words count;
* corrections - how many times backspace was used.
- It allows to go back only at the limits of the same word;
- Countdown time can be changed in `src/config.js` file.
- The countdown starts upon pressing any key.
- Press `Enter` to restart with the same text or `Esc`/"Restart" button to restart with different text.
- **WPM** and **Accuracy** stats are displayed in real-time, updating every second.
- At the end of each session, a chart appears showing the gameplay history of up to 20 previous sessions. More details can be viewed by hovering the mouse over each session indicator circle:
- Date and time the test was taken.
- WPM - words per minute.
- Accuracy - percentage of correct words.
- Count of correct words.
- Count of wrong words.
- Corrections - how many times backspace was used.
- It only allows going back within the boundaries of the same word.
- The countdown time can be adjusted in the `src/config.js` file.
- Incorrect letters at the end of the word will be appended:
* only up to `5` letters (it can be adjusted at `src/config.js`) or the edge of input window border;
- Up to `5` letters (adjustable in `src/config.js`) or until reaching the edge of the input window border.

## Tech Stack

Expand Down

0 comments on commit 3b03603

Please sign in to comment.