Skip to content
This repository has been archived by the owner on Sep 26, 2024. It is now read-only.

Add an Entity Relationship Diagram (ERD) in the readme.md #145

Open
gabriel19913 opened this issue Aug 30, 2020 · 2 comments
Open

Add an Entity Relationship Diagram (ERD) in the readme.md #145

gabriel19913 opened this issue Aug 30, 2020 · 2 comments
Labels
enhancement New feature or request

Comments

@gabriel19913
Copy link

I think would be nice to add an ERD in the readme.md. This will make easier to see how the data are relationed in the database, also it makes easier to know what data is available in the API.

@mmondelli
Copy link

I agree. I can do that.

I was just wondering if the readme.md file can get a little polluted since one of the tables has a large number of columns.
I thought of creating a short version of the ER (with only the entities' names and relationships) and a second more detailed version in a different file. This second file could even have a data dictionary.
Does this make sense?

@gabriel19913
Copy link
Author

Hi @mmondelli I agree with you.
Usually I add the ERD in the readme of my projects, but really it can make the readme a little bit polluted in this project.
So I think you can do in this way. Thanks.

@ogecece ogecece added the enhancement New feature or request label Oct 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants