Agregar contenido detallado al README.md

[Brayan-724]

Mejorar el archivo README.md con información clara y completa sobre el proyecto, sus características, requisitos, instalación y uso. Esto proporcionará una visión general del proyecto a los nuevos desarrolladores y usuarios, y facilitará la comprensión de cómo empezar a trabajar con la herramienta.

Tareas:

• Introducción al proyecto:

  • Agregar una breve descripción del propósito de la herramienta y su funcionalidad principal.
  • Explicar de manera concisa a quién está dirigida la herramienta (desarrolladores, equipos técnicos, etc.).

• Características principales:

  • Detallar las características principales del proyecto, como soporte para múltiples sintaxis de marcado, sistema de traducciones, hot-reload, temas y templates, servidor de archivos estáticos, y soporte completo para Markdown.
  • Incluir ejemplos o explicaciones breves de cada característica.

• Requisitos:

  • Incluir una sección de requisitos previos, especificando las versiones mínimas de las herramientas necesarias (por ejemplo, Rust).
  • Enumerar las dependencias del proyecto, explicando brevemente para qué se utilizan.

• Instalación:

  • Proporcionar instrucciones claras para instalar el proyecto y sus dependencias. Asegurarse de incluir tanto el proceso de instalación con Rust como con los gestores de paquetes relevantes.

• Uso básico:

  • Agregar ejemplos sencillos de cómo generar documentación usando la herramienta.
  • Incluir ejemplos para distintas sintaxis de marcado (Markdown, reStructuredText, AsciiDoc).

• Contribuciones y licencias:

  • Añadir una sección sobre cómo contribuir al proyecto, incluyendo el flujo de trabajo para Pull Requests, problemas, y código de conducta.
  • Agregar una sección sobre la licencia del proyecto.