From 93ee5270844d2c4ddbbd1beae816876b1bb8bd44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADtor=20Vieira?= Date: Fri, 28 Nov 2025 20:34:29 +0000 Subject: [PATCH] Updated README --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 955885c..73ac30e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ # Uphold currency rate bot for interview -This project includes a simple API to checkout statistics and health monitoring (requires running DB) - ## Requirements - Node.js >= v20 -- Docker and Docker Compose (optionally, Podman and Podman compose ) -- PostgreSQL (optional, runs in-memory without it) +- Docker and Docker Compose (optionally, Podman and Podman compose) +- PostgreSQL (if running outside of Docker) ## Quick Start @@ -137,12 +135,12 @@ curl http://localhost:3000/alerts?limit=100 ## Architecture - `index.js` - Entry point -- `src/bot.js` - Bot logic +- `src/bot.js` - Bot logic - `src/api.js` - Uphold API client -- `src/db.js` - PostgreSQL persistence layer +- `src/db.js` - DB logic - `src/logger.js` - Simple logging - `src/server.js` - API server for docker diagnosis -- `src/stats.js` - Runtime statistics tracking +- `src/stats.js` - Statistics tracking - `tests/bot.test.js` - Tests ## Stopping the Bot