# erd-rs

**Repository Path**: nur/erd-rs

## Basic Information

- **Project Name**: erd-rs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-02-08
- **Last Updated**: 2025-02-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# erd-rs

Rust CLI tool for creating entity-relationship diagrams from plain text markup.
Based on [erd](https://github.com/BurntSushi/erd) (uses the same input format
and output rendering).

Entities, relationships and attributes are defined in a simple plain text
markup format, which is used to generate an entity-relationship diagram in
[DOT](https://en.wikipedia.org/wiki/DOT_(graph_description_language)) format.

This can then be rendered into e.g. pdf, png, svg, etc. using
[Graphviz](https://graphviz.org/) or another similar tool.

## Status

Currently under development, general parsing and mostly default output is
completed, but not yet feature complete.

Approximate TODO:

* rendering customisation
* checks that entities exist when parsing relationships
* code cleanup/refactoring
* internal function/parser documentation
* user guide/overvie(is implemented, but rendering is not)w
* additional error handling
* add github actions to run tests
* add action to build/push docker image to docker hub