add readme

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## [1.0.1] - 2024-11-11
+### Added
+- Updated Readme with Aiven Resources
+
+## [1.0.0] - 2024-11-10
+### Added
+- Initial release of SQL Optimizer.
+- Added support for query optimization.

README.md

@@ -0,0 +1,60 @@
+<div align="center">
+<h1>
+
+<picture>
+  <source srcset="https://github.com/aiven/aiven-sql-optimizer-vscode/raw/main/assets/images/aiven_logo_dark_theme.png" media="(prefers-color-scheme: dark)">
+  <img src="https://github.com/aiven/aiven-sql-optimizer-vscode/raw/main/assets/images/aiven_logo.png" width=800>
+</picture>
+
+<b>SQL Optimizer by Aiven</b>
+
+</h1>
+
+<h3>Optimize your SQL queries with <a href="https://aiven.io">Aiven</a> for improved performance and efficiency.</h3>
+
+[![Version](https://img.shields.io/visual-studio-marketplace/v/Aiven.aiven-sql-optimizer-extension?style=for-the-badge&color=%23e38a14
+)](https://marketplace.visualstudio.com/items?itemName=Aiven.aiven-sql-optimizer-extension)
+[![Ratings](https://img.shields.io/visual-studio-marketplace/r/Aiven.aiven-sql-optimizer-extension?style=for-the-badge&color=%23e38a14)](https://marketplace.visualstudio.com/items?itemName=Aiven.aiven-sql-optimizer-extension)
+
+
+<br/>
+
+<video src="https://github.com/aiven/aiven-sql-optimizer-vscode/raw/main/assets/videos/how_to_use.mp4" controls loop muted autoplay title="How to use Aiven SQL Optimizer" width=1000></video>
+
+</div>
+
+
+## Optimize a SQL Query:
+
+<p> 1. Select the desired SQL query text in the editor.</p>
+<p> 2. Right-click the selected text or press <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> to open the Command Pallete.</p>
+<p> 3. Select <kbd>Optimize SQL with Aiven</kbd></p>
+
+<br/>
+
+
+## Suported Databases
+
+Aiven focuses on optimizing your experience with MySQL, PostgreSQL, Aurora for MySQL, MariaDB and Percona Server. Some of Aiven's recommendations may apply to other databases such as Oracle and SQL Server as well.
+
+<br/>
+
+## Aiven Resources
+
+<p><a href="https://aiven.io/tools/sql-query-optimizer">Online SQL Optimizer for PostgreSQL and MySQL</a></p>
+<p><a href="https://aiven.io/tools/sql-formatter">SQL Formatter</a></p>
+<p><a href="https://aiven.io/tools/sql-syntax-checker">SQL Syntax Checker</a></p>
+
+
+<br/>
+
+## Release Notes
+
+### 1.0.1
+
+- Updated Readme with Aiven Resources
+
+### 1.0.0
+
+- Initial release of Aiven SQL Optimizer
+