diff --git a/README.md b/README.md index c7aee98..eb0bc06 100644 --- a/README.md +++ b/README.md @@ -6,26 +6,22 @@ Obtiene y publica precios de criptomonedas. ## Instalación y ejecución desde CLI -Descargar el repositorio en una nueva carpeta: +1. Descargar el repositorio en una nueva carpeta: -````shell -git clone https://git.cuzo.dev/Parra/crypto-reporter.git -```` - -Copiar el fichero `env_file` a `.env` y abrirlo con un editor de textos y editarlo +2. Copiar el fichero `env_file` a `.env` y abrirlo con un editor de textos y editarlo con la información del servidor MQTT, así como editar los tópicos que se quieran usar y el tiempo de refresco. -Dar permisos de ejecución al fichero principal con `chmod +x main.py` y ejecutar con `./main.py`. +3. Dar permisos de ejecución al fichero principal con `chmod +x main.py` y ejecutar con `./main.py`. ## Instalación y ejecución desde Docker -Crear una carpeta (por ejemplo `crypto-reporter`) y acceder a ella. +1. Crear una carpeta (por ejemplo `crypto-reporter`) y acceder a ella. -Crear un fichero `.env` con el contenido del fichero `env_file` de este repositorio y +2. Crear un fichero `.env` con el contenido del fichero `env_file` de este repositorio y editarlo con la información del servidor MQTT. -Crear un fichero `docker-compose.yml` como el siguiente: +3. Crear un fichero `docker-compose.yml` como el siguiente: ````yml version: '3' @@ -38,8 +34,8 @@ services: - ./.env:/.env:ro ```` -Ejecutar con el comando `docker compose up -d`. +4. Ejecutar con el comando `docker compose up -d`. ## Menciones -La API se extrae de Coingecko y se puede consultar aquí: https://www.coingecko.com/en/api/documentation \ No newline at end of file +La API se extrae de Coingecko y se puede consultar aquí: https://www.coingecko.com/en/api/documentation