From 57196d9189556bf27eee8d8ca5ebcd85e9d19dcd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?O=CC=81scar=20M=2E=20Lage?= Date: Thu, 28 Nov 2024 13:57:46 +0100 Subject: [PATCH] Minor README fixes --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 38e1a9f..fed4cbc 100644 --- a/README.md +++ b/README.md @@ -10,19 +10,19 @@ Este comando inicia un servidor web que permite visualizar los eventos de calefa #### Uso: ```bash -go run cmd/web/main.go +$ go run cmd/web/main.go ``` #### Opciones: -- WEB_PORT: Puerto en el que se ejecuta el servidor web. Puedes configurarlo en el archivo .env. +- WEB_PORT: Puerto en el que se ejecuta el servidor web. Puedes configurarlo en el archivo `.env`. ### 2. Comando Bot Este comando inicia un bot de Telegram que permite interactuar con el sistema de calefacción a través de mensajes. #### Uso: ```sh -go run cmd/bot/main.go +$ go run cmd/bot/main.go ``` #### Opciones: @@ -36,9 +36,10 @@ Este comando importa los datos de un archivo CSV (con formato específico) a la #### Uso: ``` -go run cmd/import/main.go -f /ruta/al/archivo.csv --f, --file: Especifica la ruta del archivo CSV a importar. ---dry-run: Muestra los datos que se importarían sin hacer cambios en la base de datos (útil para verificar la información antes de insertarla). +$ go run cmd/import/main.go -f /ruta/al/archivo.csv + -f, --file: Especifica la ruta del archivo CSV a importar. + --dry-run: Muestra los datos que se importarían sin hacer cambios en la base de datos + (útil para verificar la información antes de insertarla). ``` #### Configuración @@ -46,7 +47,7 @@ go run cmd/import/main.go -f /ruta/al/archivo.csv 1. Crear archivo .env Copia el archivo .env.sample a .env y configura las variables de entorno necesarias: ```sh -cp .env.sample .env +$ cp .env.sample .env ``` Luego edita el archivo .env con los valores correspondientes: ```ini @@ -58,14 +59,14 @@ WEB_PORT=9900 ``` 2. Base de Datos -El proyecto utiliza una base de datos SQLite para almacenar los eventos de calefacción. La configuración de la base de datos se gestiona automáticamente a través del código en el archivo internal/config/db.go. Asegúrate de que el archivo de la base de datos se encuentra en la ubicación correcta para que la conexión funcione correctamente. +El proyecto utiliza una base de datos SQLite para almacenar los eventos de calefacción. La configuración de la base de datos se gestiona automáticamente a través del código en el archivo `internal/config/db.go`. Asegúrate de que el archivo de la base de datos se encuentra en la ubicación correcta para que la conexión funcione correctamente. ### Dependencias Este proyecto utiliza varias dependencias de Go. Asegúrate de tenerlas instaladas y configuradas correctamente: ```sh -go mod tidy +$ go mod tidy ``` ### Estructura del Proyecto