From 3f10b3edb023b79a2b7b5da8783d30be9bf9db85 Mon Sep 17 00:00:00 2001 From: William Correa Date: Tue, 9 Apr 2024 20:02:04 -0300 Subject: [PATCH] feature: update README.md --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 49 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 91e61f0..6bf073a 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,54 @@ - -# Super Quizz +# 🎮 Super Quizz O Super Quizz é um projeto que permite que sejam inseridos jogos de forma simples e rápida em backend e que o mesmo alimente de forma eficiente um frontend. +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) + +## 📌 Conteúdo + +- [🎮 Super Quizz](#super-quizz-️) + - [📌 Conteúdo](#-table-of-contents) + - [🗣 Introdução](#-introduction) + - [✨ Tecnologias](#-features) + - [🚀 Como começar](#-get-started) + - [🖥 Como contribuir](#-installation) + - [👋 Sobre o ombro de gigantes](#-) + - [🗣 Escudos](#-) + - [🚨 License](#-license) + +## 🗣 Introdução + +Bem-vindo ao Super Quizz: o jogo de perguntas definitivo! + +Prepare-se para uma experiência única de desafios intelectuais, onde o conhecimento é a chave para a vitória! Super Quizz não é apenas mais um jogo de perguntas e respostas - é uma plataforma inovadora, projetada desde o seu nascedouro para proporcionar uma variedade de configurações avançadas e modos de jogo empolgantes. + +#### Explore a Diversidade + +Com o Super Quizz, a diversão nunca é limitada. Desde temas amplos até nichos específicos, há uma infinidade de categorias para explorar. De história a entretenimento, ciência a cultura pop, cada rodada é uma nova oportunidade de aprendizado e desafio. + +#### Configuração Personalizada + +Assuma o controle total sobre sua experiência de jogo. Com configurações avançadas, você pode ajustar o nível de dificuldade, definir limites de tempo e até mesmo criar seus próprios conjuntos de perguntas. De novatos a mestres, todos encontrarão um desafio adequado às suas habilidades. -## Tecnologias +#### Modos de Jogo Exclusivos + +Dê um toque especial à sua partida com uma variedade de modos de jogo emocionantes. Desde competições individuais aceleradas até desafios em equipe estratégicos, há algo para todos os estilos de jogo. Prepare-se para testar sua agilidade mental, estratégia e trabalho em equipe como nunca antes. + +#### Uma Comunidade de Aprendizado + +Junte-se a uma comunidade vibrante de jogadores dedicados e entusiastas do conhecimento. Compartilhe dicas, desafie amigos e participe de torneios emocionantes. No Super Quizz, o aprendizado é uma jornada coletiva, e cada partida é uma oportunidade para expandir horizontes e conectar-se com pessoas de todo o mundo. + +#### Pronto para o Desafio? + +Prepare-se para uma aventura intelectual como nenhuma outra. Com o Super Quizz, a diversão está sempre garantida, seja sozinho, com amigos ou em competições épicas. Você tem o que é preciso para se tornar o mestre das perguntas? Aventure-se agora e descubra! + +## ✨ Tecnologias Foram utilizadas apenas as bibliotecas React e Bootstrap para desenhar as principais interfaces gráficas. Há configuração padrão para consumir uma backend Supabase ou uma API HTTP que responda JSON. Como os componentes estão bem distribuídos não será muito desafiador configurar outras fontes de dados. - -## Rodar Localmente +## 🚀 Como começar Crie um clone do projeto localmente @@ -25,6 +62,8 @@ Mude a pasta atual do seu terminal para rodar os próximos comandos no lugar cor cd quiz ``` +### 🖥 Configurando tudo + Instale as depedências do projeto ```bash @@ -44,7 +83,9 @@ Para iniciar o modo de desenvolvimento use o comando abaixo ``` -## Acknowledgements +## 👋 Sobre o ombro de gigantes + +Muita gente correu pra gente chegar até aqui :heart: - [Site do PHPinga do PHPPB](http://php-pb.net/PHPinga/) - [Site do PHPinga do PHP com Rapadura](https://phpcomrapadura.org/phpinga/) @@ -52,14 +93,14 @@ Para iniciar o modo de desenvolvimento use o comando abaixo - [PHP com Rapadura no Twitter](https://twitter.com/phpcomrapadura) -## Badges +## 🗣 Escudos [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/) [![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](https://opensource.org/licenses/) [![AGPL License](https://img.shields.io/badge/license-AGPL-blue.svg)](http://www.gnu.org/licenses/agpl-3.0) -## License +## 🚨 License [MIT](https://choosealicense.com/licenses/mit/)