Merge pull request #13 from IkezoeMakoto/readme-update

readmeを更新した

.github/workflows/deploy.yml

@@ -56,15 +56,15 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        os: [mac64, lin64, win64]
+        os: [Darwin_x86_64, Linux_x86_64, Windows_x86_64]
         include:
-          - os: mac64
+          - os: Darwin_x86_64
             goos: darwin
             arch: amd64
-          - os: lin64
+          - os: Linux_x86_64
             goos: linux
             arch: amd64
-          - os: win64
+          - os: Windows_x86_64
             goos: windows
             arch: amd64
 

README.md

@@ -1,5 +1,40 @@
 # dbdog
 dbdog is a table definition automatic generation tool!
 
+![screenshot](https://user-images.githubusercontent.com/7962629/86523622-f527d400-bea9-11ea-8622-ea740aff6d7e.png)
+
+## How to use
+### install
+go get
+```
+go get -u github.com/IkezoeMakoto/dbdog
+```
+or
+binary download
+```
+wget "https://github.com/IkezoeMakoto/dbdog/releases/download/v0.0.2/dbdog_$(uname -s)-$(uname -m).zip"
+unzip dbdog_linux_amd64.zip
+mv dbdog /usr/local/bin
+```
+
+### config
+your db setting
+```
+vim config.toml
+```
+
+### use
+```
+dbdog
+##########################################################
+   ___  ___     __
+  / _ \/ _ )___/ /__  ___ _
+ / // / _  / _  / _ \/ _ `/
+/____/____/\_,_/\___/\_, /
+                    /___/
+##########################################################
+# dbdog is a table definition automatic generation tool! #
+```
+
 ## output
 [output-example.md](output-example.md)