readme.md

maru44 · Mar 1, 2022 · 02b2286 · 02b2286
1 parent 0ac4d68
commit 02b2286
Showing 1 changed file with 41 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -5,10 +5,28 @@
 
 Scheman is a tool to write database schema from connected database. Also output ERD (mermaid).
 
+You can choose output destination from `Notion`, `File` or both of them.
+
+### Images
+
+Here is examples for output.
+
+#### Notion
+
 ![](https://user-images.githubusercontent.com/46714011/155822065-f0f9f785-b2b1-4abd-b98b-052496dff169.png)
 
 ![](https://user-images.githubusercontent.com/46714011/155862202-77e81b99-681a-44fb-bf1c-669dae7f1f5a.png)
 
+#### File
+
+##### definition
+
+https://github.com/maru44/scheman/blob/master/testdata/postgres/def.csv
+
+##### ERD
+
+https://github.com/maru44/scheman/blob/master/testdata/postgres/erd.md
+
 #### Supported Databases
 
 | Database     | Test Confirmed |
@@ -26,36 +44,46 @@ Only Notion is supported as output destination now. But I am going to add output
 | Output Destination | Test Confirmed |
 | ------------------ | -------------- |
 | Notion             | 👌             |
+| File               | 👌             |
 
 ## How to Use
 
 Install this package and write settings for connection.
 
 **_installation_**
 
-```
-go install github.com/maru44/scheman@v1.1.0
+```shell: installation
+go install github.com/maru44/scheman@v1.2.0
 ```
 
 **_example for PostgreSQL - Notion)_**
 
-```
+```shell: Notion - PostgreSQL
 go install github.com/volatiletech/sqlboiler/v4/drivers/sqlboiler-psql@v4.8.6 \
  && scheman psql --notion-token ${NOTION_TOKEN} --notion-page-id ${PSQL_NOTION_PAGE_ID}
 ```
 
+**_example for MySQL - File with sqlboiler.toml)_**
+
+```shell: File - MySQL
+github.com/volatiletech/sqlboiler/v4/drivers/sqlboiler-mysql@v4.8.6 \
+ && scheman mysql -c sqlboiler.toml --def-file def.csv --erd-file erd.md
+```
+
 #### Generic config options
 
-| Name               | Defaults   |                                                  |
-| ------------------ | ---------- | ------------------------------------------------ |
-| config             | "scheman"  |                                                  |
-| services           | ["NOTION"] |                                                  |
-| erd-outputs        | ["NOTION"] | mermaid format                                   |
-| notion-page-id     | ""         | required if output destinations contain "NOTION" |
-| notion-page-token  | ""         | required if output destinations contain "NOTION" |
-| notion-table-index | ""         |                                                  |
-| disable-views      | false      |                                                  |
-| attr-ignore        | [ ]        |                                                  |
+| Name               | Defaults   |                                                                                                  |
+| ------------------ | ---------- | ------------------------------------------------------------------------------------------------ |
+| config             | "scheman"  | if you use sqlboiler, you can use sqlboiler.toml(.yaml) with setting this "sqlboiler.toml(.yaml) |
+| services           | ["NOTION"] | NOTION, FILE or both of them                                                                     |
+| erd-outputs        | ["NOTION"] | NOTION, FILE or both of them (mermaid format)                                                    |
+| notion-page-id     | ""         | required if output destinations contain "NOTION"                                                 |
+| notion-page-token  | ""         | required if output destinations contain "NOTION"                                                 |
+| notion-table-index | ""         | if you want to overwrite definition table, please fill this                                      |
+| def-file           | ""         | required if output destinations (for definition) contain "FILE"                                  |
+| erd-file           | ""         | required if output destinations (for ERD) contain "FILE"                                         |
+| disable-views      | false      |                                                                                                  |
+| attr-ignore        | [ ]        |                                                                                                  |
 
 #### Database Driver Configuration