docs: update readme and add a build-log

Author: telicoscience

README.md README .mdREADME.md renamed to README .md

@@ -1,7 +1,6 @@
 # rest-api-flask (Flask + MongoDB)
 
-REST API built with Flask and Flask-RESTful, using MongoDB via MongoEngine.
-The project focuses on clean configuration per environment, containerized setup, and automated testing/pipeline.
+REST API built with Flask and Flask-RESTful, using MongoDB via MongoEngine. The project focuses on clean configuration per environment, containerized setup, and automated testing/pipeline.
 
 ## Tech Stack
 - Python + Flask + Flask-RESTful
@@ -39,3 +38,26 @@ python -m venv .venv
 source .venv/bin/activate
 pip install -r requirements.txt
 python wsgi.py
+```
+
+## Running with Docker Compose
+```bash
+docker compose up --build
+```
+
+## Testing
+```bash
+pytest -q
+```
+
+## Project structure (high level)
+- `app.py` / `wsgi.py`: entrypoints
+- `config.py`: environment-based configuration (dev/prod/mock)
+- `application/`: app factory + resources + models (MongoEngine)
+
+## Roadmap (Next)
+- Add tests for PATCH endpoint
+- Implement DELETE endpoint
+- Add `/health` endpoint with DB check
+- Improve response serialization (consistent JSON)
+- Add MongoDB volume in compose for persistence

docs_build-log.md

@@ -0,0 +1,25 @@
+# Build log — rest-api-flask
+
+A short timeline of what was implemented, in order, to make it easier to recall details during reviews and interviews.
+
+## Build timeline
+1) Repo created + SSH keys configured
+2) venv + pip setup + first Flask run
+3) Flask-RESTful added + reqparse for first POST
+4) Linting added (flake8)
+5) MongoEngine integration + basic CRUD
+6) CPF validation (check digits)
+7) Users listing + user-not-found handling
+8) Application Factory pattern + decoupled structure
+9) Dockerfile + Docker Compose adjustments
+10) Insomnia collections (local + production)
+11) Pytest added + fixtures + POST test
+12) MongoDB Atlas setup
+13) Deploy to Vercel + production environment config
+14) GitHub Actions pipeline + CI secrets configured
+15) PATCH route implemented
+
+## Next steps
+- Write tests for PATCH route
+- Implement DELETE route
+- Add /health endpoint + DB check