Skip to content

Commit ce20863

Browse files
committed
feat(docs): add version module and badges (release, python, dependencies) to README
1 parent b5f4f2e commit ce20863

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# SQLumAI
22
[![CI](https://github.com/Caripson/SQLumAI/actions/workflows/ci.yml/badge.svg)](https://github.com/Caripson/SQLumAI/actions)
3+
[![Release](https://img.shields.io/github/v/release/Caripson/SQLumAI?display_name=tag&sort=semver)](https://github.com/Caripson/SQLumAI/releases)
4+
[![Version](https://img.shields.io/badge/version-0.1.0-blue)](#)
5+
[![Python](https://img.shields.io/badge/Python-3.10%20|%203.11%20|%203.12-3776AB?logo=python&logoColor=white)](#)
36
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
47

58
SQLumAI is an invisible, AI‑powered proxy for Microsoft SQL Server.
@@ -12,6 +15,9 @@ For non‑technical readers
1215

1316
Developed by Johan Caripson.
1417

18+
Dependencies
19+
- ![FastAPI](https://img.shields.io/pypi/v/fastapi?label=fastapi) ![Uvicorn](https://img.shields.io/pypi/v/uvicorn?label=uvicorn) ![Pydantic](https://img.shields.io/pypi/v/pydantic?label=pydantic) ![HTTPX](https://img.shields.io/pypi/v/httpx?label=httpx) ![prometheus_client](https://img.shields.io/pypi/v/prometheus_client?label=prometheus_client)
20+
1521
## Quick Start
1622
- Docker: `docker compose up` (starts SQL Server + proxy + API).
1723
- Local: `make setup` then `make dev`.

src/version.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
"""Project version information.
2+
3+
Single source of truth for the SQLumAI release version.
4+
Update this when cutting a new release and reference it from code or scripts.
5+
"""
6+
7+
__all__ = ["__version__"]
8+
9+
# Semantic version of the project
10+
__version__ = "0.1.0"
11+

0 commit comments

Comments
 (0)