Merge pull request #23 from kaishuu0123/support/update-readme

refs #16 #22: Update README.md

README.md

@@ -44,8 +44,42 @@ Export to file
 
 1. Press `Ctrl+Shift+p` (windows) or `Command+Shift+p` (Mac) and select `ERD: Save as SVG` or `ERD: Save as PNG` or `ERD: Save as PDF`.
 
+## Setup
+### Windows
+
+1. Download erd-go from https://github.com/kaishuu0123/erd-go/releases.
+   * Destination directory Example
+   * C:\Users\<user name>\Tools\windows_amd64_erd-go.exe
+2. Download dot program from https://github.com/kaishuu0123/graphviz-dot.js/releases
+   * Destination directory Example
+   * C:\Users\<user name>\Tools\graphviz-dot-win-x64.exe
+   * When you want to use png output
+     * Install graphviz
+     * https://www.graphviz.org
+3. edit vscode settings.json
+    ```json
+    {
+        "erd-preview.erdPath": "C:\\Users\\<user name>\\Tools\\windows_amd64_erd-go.exe",
+        "erd-preview.dotPath": "C:\\Users\\<user name>\\Tools\\graphviz-dot-win-x64.exe",
+    }
+    ```
+    * When uou want to use png output
+      * Please search dot.exe program path.
+      * ex.) C:\Program Files(x86)\Graphviz2.30\bin\dot.exe
+
+### MacOSX
+
+## Credits
+
+This work is based off of several existing projects:
+
+* https://github.com/qjebbs/vscode-plantuml
+* https://github.com/vitaliymaz/vscode-svg-previewer
+
 ## Known Issues
 
+* https://github.com/kaishuu0123/vscode-erd/issues
+
 ## Release Notes
 
 -----------------------------------------------------------------------------------------------------------

package.json

@@ -2,7 +2,7 @@
     "name": "vscode-erd-preview",
     "displayName": "ERD Preview",
     "description": "An extension for Visual Studio Code to preview erd(.er) files",
-    "version": "4.0.1",
+    "version": "4.0.2",
     "publisher": "kaishuu0123",
     "engines": {
         "vscode": "^1.25.0"