Legend

[pltrdy-spash]

Hi,

Thanks for this great package!

Where could I find a legend i.e. a list of shapes/arrows and there meaning?
I could not find which standard notation does this package follows.
I would be interesting to also add the legend in the output image (only listing what's present on the diagram)

Thanks

[jayqi]

Hi @pltrdy-spash,

The notation we use is called "Crow's foot notation"—it's one of the common notations used by entity relationship diagrams. The notation is currently documented on the "Customizing Diagrams" page, but this question prompts me to think that it should maybe be documented in a more clear place.

Interesting suggestion about a legend. I'll keep this issue open to track the idea.

[pltrdy-spash]

Thanks for quick answer, very clear!

Adding it in Github/website home page would make sense to me e.g. below the diagram image for example.

[jayqi]

#172 has added a section to the top of the README that explains what is being diagrammed, with a link to the documentation page on Crow's foot notation. I'm going to consider that good enough for now to avoid putting too much detail into the README.