Enhance README

README.md

@@ -1,94 +1,97 @@
-# Mario Kart 3.js - JavaScript/WebGL Mario Kart
+[![Link](https://raw.githubusercontent.com/Lunakepio/Mario-Kart-3.js/main/public/logo.png)](https://mario-kart-3-js.vercel.app/)
 
-[Link](https://mario-kart-3-js.vercel.app/)
+
+# Welcome to Mario Kart 3.js, a JavaScript/WebGL Mario Kart project!
+<div align="center">
+  <a href="https://github.com/Lunakepio/Mario-Kart-3.js/stargazers"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/Lunakepio/Mario-Kart-3.js"></a>
+  <a href="https://github.com/Lunakepio/Mario-Kart-3.js/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>
+  <a href="https://github.com/Lunakepio/Mario-Kart-3.js/actions/workflows/deploy-to-gh-pages.yml"><img alt="Github Actions" src="https://img.shields.io/github/actions/workflow/status/Lunakepio/Mario-Kart-3.js/deploy-to-gh-pages.yml"></a>
+</div>
 
 [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/Lunakepio/Mario-Kart-3.js)
 
-DISCLAIMER : This is not a completed project, I would say around 50% of the work has been done up to now. It takes a lot of time so please enjoy.
+⚠️ DISCLAIMER : Please note that this project is still in progress, so your patience is appreciated as we work on it. Enjoy !
+<br><br>
 
-## How to install
+![](https://geps.dev/progress/50) of the work has been done up to now. 
+<br><br>
 
-Fork the repository
+### ✨ Our Contributors
+<a href="https://github.com/Lunakepio/Mario-Kart-3.js/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=Lunakepio/Mario-Kart-3.js" />
+</a>
 
-Clone the repository or download it
 
-Open your terminal and inside the project folder, run :
+## ⬇️ Installation
+To get started, follow these steps:
 
+1. Fork the repository
+2. Clone the repository or download it
+3. Open your terminal and inside the project folder, run :
 ```bash
   npm install
 ```
-
-Start the dev server
-
+4. Start the dev server
 ```bash
   npm run dev
 ```
 
-## How to use (Gameplay)
-
+## 🕹️ Gameplay Controls
+### Keyboard/Mouse [QWERTY]
 - Use the <kbd>W</kbd> key to accelerate, the mouse to steer for now (will be updated for mobile/gamepad/keyboard).
-
 - Steer with the mouse.
+- Press and hold the space bar to initiate a drift. Steer and counter steer to maintain the drift. Release it to get a mini - turbo.
+- Press <kbd>E</kbd> key to use the current item.
+- Press <kbd>R</kbd> to reset your position, usable anytime.
 
-- Press and hold the space bar to initiate a drift. Steer and counter steer to maintain the drift. release it to get a mini - turbo.
+### Gamepad
+⚠️ Not yet implemented.
 
-- Press <kbd>E</kbd> key to use the current item.
+### Mobile
+- Kart accelerates on its own.
+- Steer with the ```upper left pad```.
+- Press and hold ```drift button``` to initiate a drift. Steer and counter steer to maintain the drift. Release it to get a mini - turbo.
+- Press ```item button``` to use the current item.
+- Reset not yet available.
 
+### Keyboard [QWERTY]
+- Use the <kbd>W</kbd> key to accelerate, the mouse to steer for now (will be updated for mobile/gamepad/keyboard).
+- Steer with <kbd>A</kbd> & <kbd>D</kbd>.
+- Press and hold the space bar to initiate a drift. Steer and counter steer to maintain the drift. Release it to get a mini - turbo.
+- Press <kbd>E</kbd> key to use the current item.
 - Press <kbd>R</kbd> to reset your position, usable anytime.
 
-## How to use (Code)
-
-- Anything needs update.
 
-- You can also edit the README to add elements to the To-do List.
+## 💻 Code usage
 
+- Anything needs update.
+- You can also edit the [README](https://github.com/Lunakepio/Mario-Kart-3.js/blob/main/README.md) to add elements to the [To-do List](#-to---do).
 - Feel free to bring your ideas to the project even if you can't code them.
 
-## How to use (Editor)
-
-- [Download Triplex](https://triplex.dev/download)
+## 🖌️ Editor
 
+- Download [Triplex](https://triplex.dev/download)
 - Open this project in Triplex from the projects root directory
-
 - Iterate on individual components, set props, have some fun
-
 - [Learn more about Triplex](https://triplex.dev/docs/get-started/user-interface)
 
-## TO - DO
+## 📝 TO - DO
 
 - [ ] Design Landing page
-
-- [ ] Add items
-
 - [ ] Add texture to the flame shaders
-
 - [ ] Add curve/length modifiers to drift particles 3/4
-
 - [ ] Add Skid marks
-
 - [x] Add smokes
-
 - [ ] Add wind screen effect when boosting
-
 - [ ] Improve sound design quality
-
 - [ ] Design UI for HUD
-
 - [ ] Make Time Trial mode
-
 - [ ] Design tracks and checkpoints
-
 - [ ] Improve code quality
-
 - [ ] Add Minimap
-
-- [ ] Items
+- [ ] Add Items
   - [ ] Tennis ball
   - [ ] Bomb
   - [ ] Real red shell
   - [ ] Treats
   - [ ] ?
-
-## License
-
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)