We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent ac17705 commit 36933c3Copy full SHA for 36933c3
1 file changed
README.md
@@ -1,5 +1,18 @@
1
# SQL to mermaid.js Entity Relation Diagram
2
+## This web app helps visualize SQL table creation scripts.
3
4
+## How to use
5
+
6
+1. Past your sql statements
7
+2. Click the refresh button
8
+3. Visualize tables and relationships in a entity relation diagram
9
+4. Copy the generated mermaid.js script to embed the schema in your markdown technical documentation
10
11
+## Implementation
12
13
+- sql parsing using rust
14
+- front end web app using yew framework
15
+- deployment on github pages
16
17
## Run locally
18
### How to install
@@ -32,5 +45,6 @@ npm test
32
45
### Deploy
33
46
34
47
```sh
35
-git push origin v*.*.*
48
+git tag vα.β.γ
49
+git push origin vα.β.γ
36
50
```
0 commit comments