Skip to content

Commit 987ac31

Browse files
committed
chore: update readme
1 parent 5ace9cf commit 987ac31

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,18 @@ Transform your dbt artifact files or metadata into stunning Entity Relationship
1919

2020
## 🎯 Entity Relationship Detection
2121

22-
dbterd intelligently detects entity relationships through:
22+
dbterd intelligently detects entity relationships through three algorithms — pick the one that matches how your dbt project expresses its data contracts:
2323

24-
- **🧪 [Test Relationships](https://docs.getdbt.com/reference/resource-properties/data-tests#relationships)** (default method)
25-
- **🏛️ [Semantic Entities](https://docs.getdbt.com/docs/build/entities)** (use `-a` option)
24+
- **🧪 [Test Relationships](https://docs.getdbt.com/reference/resource-properties/data-tests#relationships)** *(default)* — infers relationships from dbt `relationships` data tests
25+
- **🏛️ [Semantic Entities](https://docs.getdbt.com/docs/build/entities)** (`-a entity_relationship`) — detects relationships via dbt Semantic Layer entity definitions
26+
- **📜 Model Contract Constraints** (`-a model_contract`) — detects relationships via dbt [model contract](https://docs.getdbt.com/docs/collaborate/govern/model-contracts) `foreign_key` constraints (dbt 1.9+ / manifest v12+)
2627

2728
For detailed configuration options, see our [CLI References](https://dbterd.datnguyen.de/latest/nav/guide/cli-references.html#dbterd-run-algo-a).
2829

2930
## 🎨 Supported Output Formats
3031

32+
No need to pick just one — dbterd has a format for every occasion, from quick GitHub previews to full-blown interactive database designers.
33+
3134
| Format | Description | Use Case |
3235
|--------|-------------|----------|
3336
| **[DBML](https://dbdiagram.io/d)** | Database Markup Language | Interactive web diagrams |
@@ -61,7 +64,7 @@ dbterd --version
6164
6265
## ⚙️ Configuration Files
6366
64-
Tired of typing the same CLI arguments repeatedly? `dbterd` supports configuration files to streamline your workflow!
67+
Tired of typing the same CLI arguments repeatedly? Your fingers deserve better. `dbterd` supports configuration files to streamline your workflow!
6568
6669
```bash
6770
# Initialize a configuration file
@@ -168,9 +171,9 @@ erDiagram
168171

169172
## 🤝 Contributing
170173

171-
We welcome contributions! 🎉
174+
We welcome contributions! Whether you've found a bug, dreamed up a feature, or just want to fix a typo — you're very welcome here.
172175

173-
**Ways to contribute:** 🐛 Report bugs | 💡 Suggest features | 📝 Improve documentation | 🔧 Submit pull requests
176+
**Ways to contribute:** 🐛 Report bugs | 💡 Suggest features | 📝 Improve documentation | 🔧 Submit pull requests
174177

175178
See our **[Contributing Guide](https://dbterd.datnguyen.de/latest/nav/development/contributing-guide.html)** for detailed information.
176179

@@ -184,7 +187,7 @@ See our **[Contributing Guide](https://dbterd.datnguyen.de/latest/nav/developmen
184187

185188
## 👥 Contributors
186189

187-
A huge thanks to our amazing contributors! 🙏
190+
A huge thanks to our amazing contributors — the people who turned "wouldn't it be nice if..." into actual working code. 🙏
188191

189192
<a href="https://github.com/datnguye/dbterd/graphs/contributors">
190193
<img src="https://contrib.rocks/image?repo=datnguye/dbterd" />

0 commit comments

Comments
 (0)