From edc632368a2ea11c4216e249474cef0577c4da50 Mon Sep 17 00:00:00 2001 From: Yuval Adam <_@yuv.al> Date: Fri, 7 Mar 2025 13:57:44 +0100 Subject: Update README --- README.md | 83 ++++++++++++++++++++++++--------------------------------------- 1 file changed, 31 insertions(+), 52 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 40ede56..925768c 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,33 @@ -# React + TypeScript + Vite - -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. - -Currently, two official plugins are available: - -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh - -## Expanding the ESLint configuration - -If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules: - -```js -export default tseslint.config({ - extends: [ - // Remove ...tseslint.configs.recommended and replace with this - ...tseslint.configs.recommendedTypeChecked, - // Alternatively, use this for stricter rules - ...tseslint.configs.strictTypeChecked, - // Optionally, add this for stylistic rules - ...tseslint.configs.stylisticTypeChecked, - ], - languageOptions: { - // other options... - parserOptions: { - project: ['./tsconfig.node.json', './tsconfig.app.json'], - tsconfigRootDir: import.meta.dirname, - }, - }, -}) -``` +# Morse Hero + +https://morsehero.com/ + +A web-based game to help you learn and practice Morse code through interactive play. Listen to Morse code signals and identify the corresponding characters to improve your skills. + +## About + +Morse Hero is an engaging web application that turns learning Morse code into a fun game. The app plays Morse code audio signals and challenges you to identify the correct character from multiple options. Perfect for beginners looking to learn Morse code or experienced operators wanting to maintain their skills. + +## Features -You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules: - -```js -// eslint.config.js -import reactX from 'eslint-plugin-react-x' -import reactDom from 'eslint-plugin-react-dom' - -export default tseslint.config({ - plugins: { - // Add the react-x and react-dom plugins - 'react-x': reactX, - 'react-dom': reactDom, - }, - rules: { - // other rules... - // Enable its recommended typescript rules - ...reactX.configs['recommended-typescript'].rules, - ...reactDom.configs.recommended.rules, - }, -}) +- Interactive Morse code learning through gameplay +- Adjustable speed (WPM) settings +- Multiple choice format for character identification +- Progress tracking with score counter +- Support for letters, numbers, and special characters + +## Setup + +```bash +# Install dependencies +npm install + +# Start development server +npm run dev ``` + +Visit the local development server URL shown in your terminal to start playing. + +## Technologies + +Built with React, TypeScript, and Vite. -- cgit v1.3.1