README.md

# edocmermaid

The purpose of this tiny library is to help creating better documentation using text based
diagram that allows expressing ideas using traditional techniques like sequence diagram,
state chart and flowcharts. The [mermaid](https://mermaid-js.github.io/mermaid/)
javascript library renders Markdown-inspired text and creates each diagram dynamically. edocmermaid is just a little help to make mermaid happens when writing documentation with edoc tool.

edocmermaid brings two additional modules that include the mermaid javascript library for
each html page created by running edoc.

See [edocmermaid](https://hexdocs.pm/edocmermaid/) documentation.