Add a long description

Signed-off-by: Artyom Vancyan <[email protected]>
pysnippet · May 24, 2023 · b05153b · b05153b
1 parent edede9b
commit b05153b
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -6,7 +6,10 @@
 [![License](https://img.shields.io/pypi/l/django-mermaid.svg)](https://github.com/pysnippet/django-mermaid/blob/master/LICENSE)
 [![Tests](https://github.com/pysnippet/django-mermaid/actions/workflows/tests.yml/badge.svg)](https://github.com/pysnippet/django-mermaid/actions/workflows/tests.yml)
 
-## Install
+Mermaid is a JavaScript-based diagramming and charting tool that renders Markdown-inspired text definitions to create
+and modify diagrams dynamically. And Django Mermaid aims to use mermaid diagrams in Django templates.
+
+## Installation
 
 ```shell
 python -m pip install django-mermaid