From 7c3cee6efe06178cb7875b62e78a39f3a1858c7e Mon Sep 17 00:00:00 2001 From: Diego Villanueva <98838739+UO283615@users.noreply.github.com> Date: Sat, 27 Apr 2024 12:47:51 +0200 Subject: [PATCH] Updated the README --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8e4b75e9..283bf555 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,21 @@ # 🧠🤔 KiWiq 🥝❓📚 Visit our page [here!!!](http://kiwiq.run.place/). -WIQ is a quiz game project inspired by the engaging and thought-provoking show "Saber y Ganar." +KiWiq is a quiz game project inspired by the engaging and thought-provoking show "Saber y Ganar." We aim to create a platform that not only challenges your knowledge but also sparks curiosity and the thrill of discovery. ## What Sets WIQ Apart -🤔 Thoughtful Questions: Dive into a world of intriguing and diverse questions, all generated procedurally using WikiData. -🌐 Encourage to improve: WIQ lets you keep track of your score to see in which areas you need to improve. +🤔 Thoughtful Questions: Dive into a world of intriguing and diverse questions, all generated procedurally using WikiData. -😭 It works! after the final version final re-final (FINAL) true (final) (hotfix) +🌐 Encourage to improve: KiWiq lets you keep track of your score to motivate you into learning more. -## Features -🏆 Adaptable difficulty: You can adjust the difficulty to push your limits. +🔣 Question diversity: KiWiq offers you a variety of questions so you can test your knowledge in a variety of fields. -🌐 Multiplayer: Compete with friends and strangers to prove you are the best. +## Features +🏆 Adaptable difficulty: You can adjust the difficulty to push your limits. -🌐 Localized: Available in Spanish and English. +🌍 Localized: Available in Spanish and English. ## Contributors Contributor | Contact @@ -43,7 +42,7 @@ This repo is a basic application composed of several components. Component | Route | Description -- | -- | -- Backend/API | `api/` | The main backend service, implemented in Java SpringBoot. It serves all requests from the frontend, and it doubles as main API. It also has a JWT-based authentication system. -Question generator | `questiongenerator/` | A SpringBoot-based service, ran alongside the main backend service, that generates questions and inserts them into the database +Question generator | `questiongenerator/` | A Java program that generates questions and inserts them into the database, from where they are fetched by the API. Webapp | `webapp/` | Our own frontend to the backend. It is implemented in React 18. ***