Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update README.md to make "Getting Started" match home.mdx #1240

Merged
merged 1 commit into from
Nov 3, 2023
Merged

docs: Update README.md to make "Getting Started" match home.mdx #1240

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,22 @@ Connects to MySQL, PostgreSQL, Microsoft SQL Server and many more...

Find out more in the documentation [here](http://vscode-sqltools.mteixeira.dev/#features).

## Getting Started

SQLTools is a set of VS Code extensions that connect to, query, and display results from a SQL database manager.
(Supported databases are listed below.)

The installation process is straightforward:

* Open VS Code
* Click the Extensions view (in the left bar), then search for `@tag:sqltools-driver`.
This lists all the drivers available for SQLTools.
* Install the driver for your database. This also installs the core SQLTools extension.
* Click the SQLTools icon (in the left bar)
* Create a _connection_ to your database. To do this, hover over **CONNECTIONS** in the SQLTools pane. Click the "Add New Connection" icon and choose the driver and enter the connection parameters.

You can then open and query it from within VS Code.

## Supported Databases
To use SQLTools you will also need to install the appropriate driver extension for your database.

Expand Down
Loading