diff --git a/docs/README.md b/docs/README.md index 4fb40e62b..f8e5046df 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,11 +16,11 @@ Check out the list of [Integrations and Usages of Mermaid](./integrations.md) **Mermaid was nominated and won the JS Open Source Awards (2019) in the category "The most exciting use of technology"!!! Thanks to all involved, people committing pull requests, people answering questions and special thanks to Tyler Long who is helping me maintain the project.** -## New diagrams in 8.4 +## New diagrams in 8.5 -With version 8.4 class diagrams have got some new features, bug fixes and documentation. Another new feature in 8.4 is the new diagram type, state diagrams. +With version 8.5 there are some bug fixes and enhancements, plus a new diagram type, entity relationship diagrams. -![Image show the two new diagram types](./img/new-diagrams.png) +![Image showing the new ER diagram type](./img/er.png) ## Special note regarding version 8.2 @@ -137,6 +137,18 @@ merge newbranch ![Git graph](./img/git.png) +### Entity Relationship Diagram - :exclamation: experimental + +``` +erDiagram + CUSTOMER ||--o{ ORDER : places + ORDER ||--|{ LINE-ITEM : contains + CUSTOMER }|..|{ DELIVERY-ADDRESS : uses + +``` + +![ER diagram](./img/simple-er.png) + ## Installation ### CDN diff --git a/docs/entityRelationshipDiagram.md b/docs/entityRelationshipDiagram.md index 8a3924d3b..042adae6d 100644 --- a/docs/entityRelationshipDiagram.md +++ b/docs/entityRelationshipDiagram.md @@ -9,13 +9,13 @@ Mermaid can render ER diagrams erDiagram CUSTOMER ||--o{ ORDER : places ORDER ||--|{ LINE-ITEM : contains - CUSTOMER }|..|{ : DELIVERY-ADDRESS : uses + CUSTOMER }|..|{ DELIVERY-ADDRESS : uses ``` ```mermaid erDiagram CUSTOMER ||--o{ ORDER : places ORDER ||--|{ LINE-ITEM : contains - CUSTOMER }|..|{ : DELIVERY-ADDRESS : uses + CUSTOMER }|..|{ DELIVERY-ADDRESS : uses ``` Entity names are often capitalised, although there is no accepted standard on this, and it is not required in Mermaid. diff --git a/docs/img/er.png b/docs/img/er.png new file mode 100644 index 000000000..21c44c257 Binary files /dev/null and b/docs/img/er.png differ diff --git a/docs/img/simple-er.png b/docs/img/simple-er.png new file mode 100644 index 000000000..5e139380b Binary files /dev/null and b/docs/img/simple-er.png differ