Re:How to Write a Great Readme
by hbcondo714 on Tuesday July 18, 2023 @04:49PM
(#36778877)
Same here, I like Draw.io but just did a sequence diagram showing a Stripe integration with actors, activations and notes in a few lines of Mermaid markdown on a GitHub readme:
https://github.com/hbcondo/revenut-web#-workflow
But that diagram just renders as code for the same readme via GitHub Pages:
They're easier to read than plain text explanations for architectural layouts/customer journeys but easier to modify than images and GIFs.
Also natively supported in many flavours of markdown like Gitlab.
[1] https://github.com/mermaid-js/mermaid