From 64119550f0848a02464b481759239b01677ca172 Mon Sep 17 00:00:00 2001 From: Alberto Rigamonti Date: Fri, 21 Nov 2025 16:22:20 +0100 Subject: [PATCH] chore: updated readme --- README.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 7060f37..b22af0b 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,15 @@ A terminal-based morse code practice game built with Deno. Improve your morse co - **Multiple Difficulty Modes** - 🟢 Easy: Single letters (A-Z) - - 🟡 Medium: Single numbers (0-9) - - 🟣 Hard: Common words + - 🟡 Medium: Letters + Numbers (A-Z, 0-9) + - 🟣 Hard: Letters + Numbers + Punctuation (.,?!-/()@) + - 🔵 Challenge: Common words - 🔴 Expert: Short phrases - **Interactive TUI Interface** - Beautiful terminal UI with colors and tables - - Real-time timer for each round + - Configurable time limits (3-60 seconds) + - Dynamic time option for words/phrases (time scales with length) - Immediate feedback on answers - Progress tracking with streak counter @@ -72,7 +74,7 @@ deno task start play --mode phrases --rounds 10 --time 45 ``` Options: -- `-m, --mode ` - Game mode: `letters`, `numbers`, `words`, or `phrases` (default: letters) +- `-m, --mode ` - Game mode: `letters`, `alphanumeric`, `full`, `words`, or `phrases` (default: letters) - `-r, --rounds ` - Number of rounds (default: 10) - `-t, --time ` - Seconds per round (default: 30) @@ -98,24 +100,31 @@ deno task start reset ## How to Play -1. **Select a difficulty mode** - Choose from letters, numbers, words, or phrases -2. **Configure your game** - Set the number of rounds and time per round -3. **Translate to morse code** - You'll be shown a challenge (letter, number, word, or phrase) -4. **Enter your answer** - Type the morse code using: +1. **Select a difficulty mode** - Choose from: + - Letters only (A-Z) + - Alphanumeric (A-Z, 0-9) + - Full character set (letters, numbers, punctuation) + - Words or phrases +2. **Configure your game** - Set the number of rounds (5-50) and time per round (3-60 seconds) +3. **Enable dynamic time (optional)** - For words/phrases, time can scale based on character count +4. **Translate to morse code** - You'll be shown a challenge +5. **Enter your answer** - Type the morse code using: - `.` (dot) for short signals - `-` (dash) for long signals - Space to separate letters - `/` to separate words -5. **Get instant feedback** - See if you got it right and track your streak -6. **Review your performance** - After all rounds, view detailed statistics +6. **Get instant feedback** - See if you got it right and what your input translates to if wrong +7. **Review your performance** - After all rounds, view detailed statistics ## Morse Code Basics - Use `.` for dots and `-` for dashes - Separate letters with spaces - Use `/` for word boundaries +- Supported punctuation: `. , ? ! - / ( ) @` - Example: `HELLO` = `.... . .-.. .-.. ---` - Example: `SOS` = `... --- ...` +- Example: `HELLO WORLD` = `.... . .-.. .-.. --- / .-- --- .-. .-.. -..` ## Statistics