From 543cc5d9076e2f3fc2805ff9111f7b066528c418 Mon Sep 17 00:00:00 2001 From: Rich Brown Date: Sun, 29 Oct 2023 07:50:21 -0400 Subject: [PATCH] Add "Getting Started" to home As a relative newcomer to VScode, I had a hard time understanding how SQLTools "worked" in the VScode ecosystem. I felt your documentation was missing a description of how to get started. (I have to compliment you - the actual installation process is _flawless_, once I learned where to look.) Here's an introductory paragraph that would have been a useful hint for me. Thanks! --- docs/src/pages/en/home.mdx | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/src/pages/en/home.mdx b/docs/src/pages/en/home.mdx index 67c9aef6e..fe8fac3bc 100644 --- a/docs/src/pages/en/home.mdx +++ b/docs/src/pages/en/home.mdx @@ -40,6 +40,21 @@ 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 VScode extensions that connect to, query, and display results from a SQL database manager. +(Supported databases are listed below.) + +The installation process is straightforward: Open VScode, go to the Marketplace +and install [SQLTools](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools&ssr=false#review-details). +Then install a _driver_ for your database(s), (for example, +[MySQL/MariaDB/TiDB](https://marketplace.visualstudio.com/items?itemName=mtxr.sqltools-driver-mysql)) +Finally, create a _connection_ to your database. +You can then open and query it from within VScode. + +Check out the [Tutorial on Youtube](https://www.youtube.com/watch?v=wzdCpJY6Y4c) +that visually walks through the steps. + ## Contributing @@ -60,4 +75,4 @@ If you need help sooner, get in touch with the maintainers directly – we might George James Software has been providing innovative software solutions for over 35 years. We pride ourselves on the quality and maintainability of our code and we have built a number of tools to help developers achieve the same with their work. These are available as VS Code extensions [here](https://marketplace.visualstudio.com/publishers/georgejames). -We also help other developers to build their own extensions. If there is a tool you need building please get in touch with us at [info@georgejames.com](mailto:info@georgejames.com). \ No newline at end of file +We also help other developers to build their own extensions. If there is a tool you need building please get in touch with us at [info@georgejames.com](mailto:info@georgejames.com).