Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Changed

- The README and the documentation home page now open with a "five frameworks,
one diagram" image — the same `User`/`Order` schema written in SQLModel,
SQLAlchemy, Django, Pydantic and dataclasses, converging on the ERD they all
produce. The previous image was the bare ERD under a caption claiming five
frameworks, which the picture itself never showed. The snippets are taken
from the runnable examples in `docs/examples/`, and the entity boxes use the
primary/foreign-key colours `generator.py` emits, so the illustration matches
real output. `docs/examples/frameworks.svg` is the editable source; the
now-unreferenced `docs/examples/erd.png` is removed.

## [0.14.0] - 2026-09-14

### Added
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ The same `User` / `Order` schema in **SQLModel, SQLAlchemy 2.0, Django, Pydantic
and dataclasses** — only the syntax differs. Each one produces the **identical**
diagram:

![The same User/Order schema in SQLModel, SQLAlchemy, Django, Pydantic and dataclasses, all producing one ERD](https://raw.githubusercontent.com/devsuit-berlin/erdify/main/docs/examples/frameworks.png "Five frameworks, one diagram")

`erdify docs/examples/sqlmodel --inject README.md` keeps the diagram below in
this file. It is Mermaid, so GitHub renders it directly — and a pre-commit hook
runs the same command with `--check`, so it cannot go stale:
Expand Down
Binary file removed docs/examples/erd.png
Binary file not shown.
Binary file added docs/examples/frameworks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
89 changes: 89 additions & 0 deletions docs/examples/frameworks.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/frameworks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ see [SQL DDL](sql.md) for details.
The snippets below all describe the **same** `User` / `Order` schema — only the
syntax differs. Each one produces the **identical** diagram:

![Framework comparison ERD](../examples/erd.png "The same ERD from all five frameworks")
![The same User/Order schema in SQLModel, SQLAlchemy, Django, Pydantic and dataclasses, all producing one ERD](../examples/frameworks.png "Five frameworks, one diagram")

!!! info

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "erdify generates PlantUML, Mermaid, JSON and HTML ER diagrams from
**One ERD generator for every Python schema in your repository — parsed from
source, with no imports, no database connection and no runtime dependencies.**

![Framework comparison ERD](examples/erd.png "The same ERD from all five frameworks")
![The same User/Order schema in SQLModel, SQLAlchemy, Django, Pydantic and dataclasses, all producing one ERD](examples/frameworks.png "Five frameworks, one diagram")

The same two tables, written in SQLModel, SQLAlchemy 2.0, Django, Pydantic and
dataclasses, all render to the same diagram.
Expand Down
Loading