Merge pull request #132 from agatemosu/readme

Clean up README
midudev · Feb 26, 2024 · 0719039 · 0719039
2 parents 4eaad02 + 747c6c4
commit 0719039
Showing 1 changed file with 59 additions and 83 deletions.
diff --git a/README.md b/README.md
@@ -1,103 +1,91 @@
 <a name="readme-top"></a>
 
+<div align="center">
+
 [![Contributors][contributors-shield]][contributors-url]
 [![Forks][forks-shield]][forks-url]
 [![Stargazers][stars-shield]][stars-url]
 [![Issues][issues-shield]][issues-url]
 
-<!-- PROJECT LOGO -->
-<br />
-<div align="center">
-  <a href="https://github.com/midudev/la-velada-web-oficial">
-    <img src="https://github.com/ZeroxyDev/la-velada-web-oficial/assets/93105414/96da08dd-21c4-4e56-a3ed-f235bf176985" alt="Logo" width="800">
-  </a>
-
-  ## Web Oficial de La Velada IV
-
-  <p align="center">
-    La Velada IV es una competición de boxeo que enfrenta a Streamers, Creadores de Contenido y otras Celebridades sobre un ring.
-    <br />
-    <a href="https://github.com/midudev/la-velada-web-oficial/issues">Reportar Error</a>
-    ·
-    <a href="https://github.com/midudev/la-velada-web-oficial/issues">Sugerir algo</a>
-  </p>
+<a href="https://github.com/midudev/la-velada-web-oficial">
+  <img src="https://github.com/ZeroxyDev/la-velada-web-oficial/assets/93105414/96da08dd-21c4-4e56-a3ed-f235bf176985" alt="Logo" width="800" />
+</a>
+
+## Web oficial de La Velada IV
+
+La Velada IV es una competición de boxeo que enfrenta a streamers, creadores de contenido y otras celebridades sobre un ring.\
+[Reportar error](https://github.com/midudev/la-velada-web-oficial/issues) · [Sugerir algo](https://github.com/midudev/la-velada-web-oficial/issues)
+
 </div>
 
-<!-- TABLE OF CONTENTS -->
 <details>
-  <summary>Tabla de contenido</summary>
-  <ol>
-    <li>
-      <a href="#about-the-project">Características Principales</a>
-    </li>
-    <li>
-      <a href="#getting-started">Empezar</a>
-      <ul>
-        <li><a href="#prerequisites">Prerequisitos</a></li>
-        <li><a href="#installation">Instalación</a></li>
-      </ul>
-    </li>
-    <li><a href="#contributing">Contribuir al proyecto</a></li>
-		<li><a href="#acknowledgments">Agradecimiento</a></li>
-  </ol>
+<summary>Tabla de contenidos</summary>
+
+1. [Características principales](#características-principales)
+2. [Para empezar](#para-empezar)
+   - [Prerequisitos](#prerequisitos)
+   - [Instalación](#instalación)
+3. [Contribuir al proyecto](#contribuir-al-proyecto)
+
 </details>
 
-<!-- ABOUT THE PROJECT -->
-<a name="about-the-project"></a>
+## Características principales
 
-## Características Principales
+- **Detalles del evento**: Obtén información detallada sobre la fecha, hora, ubicación y artistas participantes.
+- **Compra de boletos**: Permite a los usuarios dirigirlos a la compra de boletos fácilmente.
+- **Redes sociales**: Conoce las redes oficiales donde podrás informarte sobre el evento.
 
-- **Detalles del Evento:** Obtén información detallada sobre la fecha, hora, ubicación y artistas participantes.
-- **Compra de Boletos:** Permite a los usuarios dirigirlos a la compra de boletos fácilmente.
-- **Redes Sociales:** Conoce las redes oficiales donde podrás informarte sobre el evento.
+Capturas de pantalla de la web de La Velada IV:
 
-Capturas de pantalla de `Web Oficial de La Velada IV`:
+![Captura de pantalla en móvil](/public/Mobile_README.png)
 
-![Captura de Pantalla de la web en móvil](/public/Mobile_README.png)
+![Captura de pantalla en ordenador](/public/Desktop_README.png)
 
 <p align="right">(<a href="#readme-top">volver arriba</a>)</p>
 
-<!-- GETTING STARTED -->
-<a name="getting-started"></a>
-## Empezar
+## Para empezar
 
-<a name="prerequisites"></a>
 ### Prerequisitos
-* PNPM (es nuestra recomendación por su eficiencia y rapidez)
-```sh
+
+- PNPM (es nuestra recomendación por su eficiencia y rapidez)
+
+  ```sh
   npm install -g pnpm
-```
+  ```
 
-* o NPM
-```sh
+- o NPM
+
+  ```sh
   npm install npm@latest -g
-```
-
-<a name="installation"></a>
+  ```
+
 ### Instalación
 
 1. Clona el repositorio
-```sh
+
+   ```sh
    git clone https://github.com/midudev/la-velada-web-oficial.git
    ```
+
 2. Instala los paquetes de NPM
-```sh
+
+   ```sh
    pnpm install
    ```
+
 3. Ejecuta el proyecto
-```sh
+
+   ```sh
    pnpm run dev
    ```
 
 <p align="right">(<a href="#readme-top">volver arriba</a>)</p>
 
-<!-- CONTRIBUTING -->
-<a name="contributing"></a>
 ## Contribuir al proyecto
 
 Las contribuciones son lo que hacen que la comunidad de código abierto sea un lugar increíble para aprender, inspirar y crear. ¡Cualquier contribución que hagas es **muy apreciada**!
 
-Si tienes alguna sugerencia que podría mejorar el proyecto, por favor haz un [_fork_](https://github.com/midudev/la-velada-web-oficial/fork) del repositorio y crea un [_pull request_](https://github.com/midudev/la-velada-web-oficial/pulls). También puedes simplemente abrir un [_issue_](https://github.com/midudev/la-velada-web-oficial/issues) con la etiqueta "enhancement".
+Si tienes alguna sugerencia que podría mejorar el proyecto, por favor haz un [_fork_](https://github.com/midudev/la-velada-web-oficial/fork) del repositorio y crea una [_pull request_](https://github.com/midudev/la-velada-web-oficial/pulls). También puedes simplemente abrir un [_issue_](https://github.com/midudev/la-velada-web-oficial/issues) con la etiqueta "enhancement".
 
 Aquí tienes una guía rápida:
 
@@ -109,7 +97,7 @@ Aquí tienes una guía rápida:
 6. Haz Push a la Rama (`git push origin feature/CaracteristicaIncreible`)
 7. Abre una [_pull request_](https://github.com/midudev/la-velada-web-oficial/pulls)
 
-Por favor, consulta nuestra [guía de contribución](https://github.com/midudev/la-velada-web-oficial/blob/master/CONTRIBUTING.md) para saber cómo puedes empezar de la mejor manera y siguiendo [buenas prácticas](https://github.com/midudev/la-velada-web-oficial/blob/main/CONTRIBUTING.md#buenas-pr%C3%A1cticas-).
+Por favor, consulta nuestra [guía de contribución](https://github.com/midudev/la-velada-web-oficial/blob/master/CONTRIBUTING.md) para saber cómo puedes empezar de la mejor manera y siguiendo [buenas prácticas](https://github.com/midudev/la-velada-web-oficial/blob/main/CONTRIBUTING.md#buenas-prácticas-).
 
 ### Contribuir desde Stackblitz
 
@@ -125,38 +113,26 @@ Si quieres contribuir de una manera mas sencilla, puedes iniciar este proyecto d
 
 ## 🛠️ Stack
 
-* [![Astro][Astro.js]][Astro-url] - The web framework for content-driven websites.
-* [![Typescript][Typescript.js]][Typescript-url] - JavaScript with syntax for types.
-* [![Tailwind CSS][Tailwind.com]][Tailwind-url] - A utility-first CSS framework for rapidly building custom designs.
-* [![@midudev/tailwind-animations][Midudev]][Midudev-url] - Easy peasy animations for your Tailwind project.
-
-<!-- ACKNOWLEDGMENTS -->
-<a name="acknowledgments"></a>
-## Agradecimiento
-
-- [Img Shields](https://shields.io)
+- [![Astro][astro-badge]][astro-url] - The web framework for content-driven websites.
+- [![Typescript][typescript-badge]][typescript-url] - JavaScript with syntax for types.
+- [![Tailwind CSS][tailwind-badge]][tailwind-url] - A utility-first CSS framework for rapidly building custom designs.
+- [![@midudev/tailwind-animations][animations-badge]][animations-url] - Easy peasy animations for your Tailwind project.
 
 <p align="right">(<a href="#readme-top">volver arriba</a>)</p>
 
-<!-- MARKDOWN LINKS & IMAGES -->
-<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
-
-[Astro-url]: https://astro.build/
-[Typescript-url]: https://www.typescriptlang.org/
-[Tailwind-url]: https://tailwindcss.com/
-[Midudev-url]: https://tailwindcss-animations.vercel.app
-[Astro.js]: https://img.shields.io/badge/Astro-fff?style=for-the-badge&logo=astro&logoColor=bd303a&color=352563
-[Typescript.js]: https://img.shields.io/badge/Typescript-007ACC?style=for-the-badge&logo=typescript&logoColor=white&color=blue
-[Tailwind.com]: https://img.shields.io/badge/Tailwind-ffffff?style=for-the-badge&logo=tailwindcss&logoColor=38bdf8
-[Midudev]: https://img.shields.io/badge/@midudev/tailwind-animations-ff69b4?style=for-the-badge&logo=node.js&logoColor=white&color=blue
+[astro-url]: https://astro.build/
+[typescript-url]: https://www.typescriptlang.org/
+[tailwind-url]: https://tailwindcss.com/
+[animations-url]: https://tailwindcss-animations.vercel.app/
+[astro-badge]: https://img.shields.io/badge/Astro-fff?style=for-the-badge&logo=astro&logoColor=bd303a&color=352563
+[typescript-badge]: https://img.shields.io/badge/Typescript-007ACC?style=for-the-badge&logo=typescript&logoColor=white&color=blue
+[tailwind-badge]: https://img.shields.io/badge/Tailwind-ffffff?style=for-the-badge&logo=tailwindcss&logoColor=38bdf8
+[animations-badge]: https://img.shields.io/badge/@midudev/tailwind-animations-ff69b4?style=for-the-badge&logo=node.js&logoColor=white&color=blue
 [contributors-shield]: https://img.shields.io/github/contributors/midudev/la-velada-web-oficial.svg?style=for-the-badge
 [contributors-url]: https://github.com/midudev/la-velada-web-oficial/graphs/contributors
-[downloads-shield]: https://img.shields.io/github/downloads/midudev/la-velada-web-oficial/total?color=%2331c754&label=Downloads&logoColor=%23ffffff
-[downloads-url]: https://github.com/midudev/la-velada-web-oficial/releases/latest
 [forks-shield]: https://img.shields.io/github/forks/midudev/la-velada-web-oficial.svg?style=for-the-badge
 [forks-url]: https://github.com/midudev/la-velada-web-oficial/network/members
 [stars-shield]: https://img.shields.io/github/stars/midudev/la-velada-web-oficial.svg?style=for-the-badge
 [stars-url]: https://github.com/midudev/la-velada-web-oficial/stargazers
 [issues-shield]: https://img.shields.io/github/issues/midudev/la-velada-web-oficial.svg?style=for-the-badge
 [issues-url]: https://github.com/midudev/la-velada-web-oficial/issues
-