Diagrams are written in Plant UML - full instructions on the website linked.
Atom is a good editor for plant UML
- PlantUML language give you syntax highlighting
- PlantUML viewer lets you a preview of your diagram
Once you've written your diagram you'll want to display it somewhere for all to see!
To automatically generate the diagrams and add them to the readme file you need to run diagram generate
# You need to have graphviz installed to generate diagrams
# if you're a windows guy
choco install javaruntime
choco install graphviz
# if you're a mac guy
brew install graphviz
# Add the path to your environment variables
# C:\Program Files (x86)\Graphviz2.38\bin
# Install diagrams globally
npm install -g diagram-cli
# init will create a /diagrams template folder
diagrams init
# make will generate all diagrams within the folder to pngs
diagrams make