docs: update README with YAML configuration instructions
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
22
README.md
22
README.md
@@ -11,3 +11,25 @@ source .venv/bin/activate # Linux/Mac
|
|||||||
pip install -r requirements.txt
|
pip install -r requirements.txt
|
||||||
uvicorn app.main:app --reload
|
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.
|
||||||
|
|||||||
Reference in New Issue
Block a user