Skip to content

Commit 02cae00

Browse files
committed
README: add demo
1 parent d260822 commit 02cae00

File tree

3 files changed

+41
-0
lines changed

3 files changed

+41
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
SQLDoc is a markdown documentation for SQL tables. Inspired by Rails ActiveRecord `schema.rb` and [drwl/annotaterb](https://github.com/drwl/annotaterb).
44

5+
![Demo of SQLDoc](demo/demo.gif)
6+
57
## Why?
68

79
Projects often manages their schema roll out through migrations (e.g. [golang-migrate/migrate](https://github.com/golang-migrate/migrate)). As a project matures, it's quite common to encounter several `ALTER TABLE` commands, which makes it difficult to have a near-instant idea of what the schema looks like.

demo/demo.gif

290 KB
Loading

demo/demo.tape

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
Output demo/demo.gif
2+
3+
Set FontSize 12
4+
Set Width 900
5+
Set Height 900
6+
7+
Type "sqldoc help"
8+
Sleep 500ms
9+
Enter
10+
Sleep 3s
11+
12+
Hide
13+
Type "clear"
14+
Enter
15+
Show
16+
17+
Type "sqldoc init"
18+
Sleep 500ms
19+
Enter
20+
21+
Type "bat sqldoc.yaml"
22+
Sleep 500ms
23+
Enter
24+
Sleep 5s
25+
26+
Hide
27+
Type "clear"
28+
Enter
29+
Show
30+
31+
Type "sqldoc"
32+
Sleep 500ms
33+
Enter
34+
Sleep 5s
35+
36+
Type "bat schema.md"
37+
Sleep 500ms
38+
Enter
39+
Sleep 5s

0 commit comments

Comments
 (0)