Skip to content
This repository was archived by the owner on Mar 12, 2020. It is now read-only.

Commit 90eff0d

Browse files
committed
Updated README.md
1 parent a399606 commit 90eff0d

File tree

2 files changed

+29
-8
lines changed

2 files changed

+29
-8
lines changed

README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
1-
![SQLTools](/icon.png?raw=true) SQLTools
1+
![SQLTools](https://github.com/mtxr/SQLTools/raw/images/icon.png?raw=true) SQLTools
22
===============
33

44
A swiss knife for SQL in Sublime Text.
55

66
Project website: [http://mtxr.github.io/SQLTools/](http://mtxr.github.io/SQLTools/)
77

88
## Features
9-
* View table schemas
10-
* View Queries history
11-
* Show table records
9+
* View table schemas (`CTRL+e, CTRL+d`)
10+
![View table schemas](https://github.com/mtxr/SQLTools/raw/images/table_description.gif?raw=true)
11+
* View Queries history (`CTRL+e, CTRL+h`)
12+
* Show table records (`CTRL+e, CTRL+s`)
13+
![Show table records](https://github.com/mtxr/SQLTools/raw/images/table_records.gif?raw=true)
1214
* Auto complete (PostgreSQL & MySQL)
13-
* Run SQL Queries
15+
* Run SQL Queries (`CTRL+e, CTRL+e`)
16+
![Auto complete (PostgreSQL & MySQL) && Run SQL Queries](https://github.com/mtxr/SQLTools/raw/images/execute_auto_complete.gif?raw=true)
17+
* Formatting SQL Queries (`CTRL+e, CTRL+b`)
18+
![Formatting SQL Queries](https://github.com/mtxr/SQLTools/raw/images/format_sql.gif?raw=true)
1419
* Threading Support (prevent ST lockups)
1520
* Query timeout (Kill thread if query takes too long)
1621
* Unescape chars for languages (PHP \" is replace by ")
@@ -24,6 +29,17 @@ Up coming features:
2429
- [ ] Run saved queries
2530
- [ ] Auto complete for Oracle and Vertica
2631

32+
## Installing
33+
34+
As long SQLTools is not in the Package Control repository yet (pull request already sent! :D) you can install SQLTools using via sublime in X steps:
35+
1. Press `CTRL+SHIFT+p`
36+
2. Type *"Add repository"*
37+
3. Paste this url https://github.com/mtxr/SQLTools
38+
4. Press `CTRL+SHIFT+p` again
39+
5. Select *"Install package"*
40+
6. Select *"SQLTools"*
41+
7. Done!
42+
2743
## Settings
2844

2945
| Option | Description | Type | Default value |
@@ -107,10 +123,15 @@ After you select one connection, SQLTools prepare auto completions for you.
107123

108124
PS: For a better experience, add this line to your sublime settings file
109125

110-
1. `CTRL+SHIFT+P`, select "*Preferences: Settings - User*"
126+
1. `CTRL+SHIFT+p`, select "*Preferences: Settings - User*"
111127
2. add this option:
112128

113129

114-
```
115-
"auto_complete_triggers": [ {"selector": "text.html", "characters": "<"}, {"selector": "source.sql", "characters": "."} ]
130+
```json
131+
{
132+
"auto_complete_triggers": [
133+
{"selector": "text.html", "characters": "<" },
134+
{"selector": "source.sql", "characters": "."}
135+
]
136+
}
116137
```

icon.png

-7.02 KB
Binary file not shown.

0 commit comments

Comments
 (0)