Skip to content

Commit c28fc7c

Browse files
committed
update documentation
1 parent f87855f commit c28fc7c

File tree

1 file changed

+37
-5
lines changed

1 file changed

+37
-5
lines changed

README.md

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ This project provides plugins that extend Draw.io with SQL and NoSQL capabilitie
1010
- Generate TypeScript interfaces
1111
- Work with various database schemas
1212

13-
## Installation
13+
## Download
1414

1515
### Option 1: Direct Download
1616

17-
Download the plugin files directly:
17+
Download the plugin files directly from the [releases page](https://github.com/funktechno/sqltooling-drawio/releases) or use the direct links below:
1818

1919
- **[sql.js](https://raw.githubusercontent.com/funktechno/sqltooling-drawio/main/dist/sql.js)** - Import/export SQL DDLs
2020
- **[nosql.js](https://raw.githubusercontent.com/funktechno/sqltooling-drawio/main/dist/nosql.js)** - Import/export OpenAPI JSONs
@@ -31,11 +31,14 @@ git clone --branch main [email protected]:funktechno/sqltooling-drawio.git
3131

3232
Then use the files from the `dist` folder.
3333

34-
### Option 3: VSCode Integration
34+
## Installation
35+
36+
### VSCode Integration
3537

3638
For VSCode users with the [Draw.io Integration](https://marketplace.visualstudio.com/items?itemName=hediet.vscode-drawio) extension:
3739

38-
Add to your `settings.json`:
40+
1. Download the plugin files from the [Download](#download) section above
41+
2. Add to your `settings.json`:
3942

4043
```json
4144
{
@@ -50,7 +53,36 @@ Add to your `settings.json`:
5053
}
5154
```
5255

53-
For more installation options, see [tam-drawio](https://github.com/ariel-bentu/tam-drawio).
56+
### Desktop App Integration
57+
58+
It's easiest to setup in the Draw.io Desktop to use the plugin. Follow these steps:
59+
60+
#### Prerequisites
61+
- Download and install [Node.js](https://nodejs.org/)
62+
63+
#### Setup Steps
64+
65+
1. **Clone or Download Draw.io Desktop**
66+
- **Option A (Git Clone)**: `git clone --recursive https://github.com/jgraph/drawio-desktop.git` (1 GB clone)
67+
- **Option B (Download ZIP)**: Download from [dev.zip](https://github.com/jgraph/drawio-desktop/archive/refs/heads/dev.zip) and unzip
68+
- ⚠️ **Note**: Don't download precompiled from Releases as you can't modify the plugins
69+
70+
2. **Install Dependencies**
71+
- Open command line (PowerShell, Command Prompt, Bash, Terminal)
72+
- Navigate to the drawio-desktop folder: `cd <path>/drawio-desktop`
73+
- Run: `npm install`
74+
75+
3. **Update SQL Plugin**
76+
- Update `drawio/src/main/webapp/plugins/sql.js` with changes from [this branch](https://raw.githubusercontent.com/funktechno/sqltooling-drawio/main/dist/sql.js)
77+
78+
4. **Run Application**
79+
- Execute: `npm start`
80+
81+
5. **Add Plugin**
82+
- In the running application, go to **Extras****Plugins****Add**
83+
- Select `sql` plugin
84+
- Close application and reopen
85+
- Plugin is now installed and ready to use
5486

5587
## Features
5688

0 commit comments

Comments
 (0)