El archivo README.md

Es la portada y el manual de bienvenida de un proyecto. Está escrito en formato Markdown (.md), que plataformas como GitHub renderizan automáticamente como una página web.

El archivo README.md es lo primero que ve cualquiera cuando entra a tu repositorio en GitHub, GitLab o Bitbucket.

¿Dónde se guarda?

El archivo README.md se guarda en la raíz del proyecto (junto al package.json).

Ventajas del archivo README.md

  • Proporciona una descripción general del proyecto.
  • Si el repositorio es público, es la carta de presentación ante reclutadores o la comunidad open source.
  • Incluye instrucciones para la instalación y configuración. Explica cómo clonar el proyecto, qué versión de Node/pnpm usar y los pasos para empezar a programar.
  • Ofrece información sobre el uso y las funcionalidades del mismo.
  • Para tu "Yo del futuro"... Cuando vuelvas a un proyecto dentro de 6 meses, el README.md permitirá recordar qué hace la aplicación, qué variables de entorno necesita y cómo se pone en marcha.

¿Qué contenido suele tener?

El archivo README.md suele contener la siguiente información:

  • Un título y una breve descripción del proyecto.
  • Instrucciones para la instalación y configuración.
  • Una guía de uso y ejemplos de cómo utilizar el proyecto.
  • Información sobre cómo contribuir al proyecto (si es open source).
  • Créditos y referencias a recursos útiles.

Ejemplo de contenido del README.md:

¿Se sube al hosting o producción?

A Git / GitHub: SÍ. SIEMPRE

Es imprescindible para documentar el código.

Al Hosting: SÍ.

Se sube junto con el código al repositorio, aunque el servidor de producción lo ignorará al compilar la web (no afecta al rendimiento ni al tamaño final del sitio).