From fb759ebe3367ae6eb6a955c2438e890349c57482 Mon Sep 17 00:00:00 2001 From: Misaka_Company Date: Tue, 12 May 2026 09:47:10 +0800 Subject: [PATCH] docs: update README with YAML configuration instructions Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index aab7446..2a8b87f 100644 --- a/README.md +++ b/README.md @@ -11,3 +11,25 @@ source .venv/bin/activate # Linux/Mac pip install -r requirements.txt uvicorn app.main:app --reload ``` + +## Configuration + +Configuration is managed via YAML files in the `config/` directory. + +### Configuration File + +Edit `config/settings.yaml` to configure your environment: + +```yaml +database: + sql_server: + host: your-host + port: 1433 + database: your-database + username: your-username + password: your-password +``` + +### Local Overrides + +For local development, create `config/settings.local.yaml` to override specific values without committing them.