Skip to content

Commit 36933c3

Browse files
committed
add presentation
1 parent ac17705 commit 36933c3

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# SQL to mermaid.js Entity Relation Diagram
2+
## This web app helps visualize SQL table creation scripts.
23

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
316

417
## Run locally
518
### How to install
@@ -32,5 +45,6 @@ npm test
3245
### Deploy
3346

3447
```sh
35-
git push origin v*.*.*
48+
git tag vα.β.γ
49+
git push origin vα.β.γ
3650
```

0 commit comments

Comments
 (0)