search

LCVcode / jockey

MIT License
2 stars 3 forks source link

Use mermaid for the Juju objects graph in README.md #31

Closed johnlettman closed 2 months ago

johnlettman commented 2 months ago

This PR uses a relatively new feature in GitHub: diagramming. https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams

I've opted to reformat the text-based diagram in README.md as a mermaid flowchart. To aid with any tweaks, there is an online tool to test changes.

A preview of the README.md can be found on my fork: https://github.com/johnlettman/pr-jockey/tree/doc/mermaid?tab=readme-ov-file#readme