vscode: update readme (#580)

disable definition provider for now since it's not working

Author: sbdchd

crates/squawk_server/src/lib.rs

@@ -5,8 +5,8 @@ use lsp_server::{Connection, Message, Notification, Response};
 use lsp_types::{
     CodeDescription, Diagnostic, DiagnosticSeverity, DidChangeTextDocumentParams,
     DidCloseTextDocumentParams, DidOpenTextDocumentParams, GotoDefinitionParams,
-    GotoDefinitionResponse, InitializeParams, Location, OneOf, Position, PublishDiagnosticsParams,
-    Range, ServerCapabilities, TextDocumentSyncCapability, TextDocumentSyncKind, Url,
+    GotoDefinitionResponse, InitializeParams, Location, Position, PublishDiagnosticsParams, Range,
+    ServerCapabilities, TextDocumentSyncCapability, TextDocumentSyncKind, Url,
     notification::{
         DidChangeTextDocument, DidCloseTextDocument, DidOpenTextDocument, Notification as _,
         PublishDiagnostics,
@@ -23,7 +23,7 @@ pub fn run() -> Result<()> {
 
     let server_capabilities = serde_json::to_value(&ServerCapabilities {
         text_document_sync: Some(TextDocumentSyncCapability::Kind(TextDocumentSyncKind::FULL)),
-        definition_provider: Some(OneOf::Left(true)),
+        // definition_provider: Some(OneOf::Left(true)),
         ..Default::default()
     })
     .unwrap();

squawk-vscode/README.md

@@ -2,7 +2,31 @@
 
 > Visual Studio Code support for Squawk
 
-## dev
+Surface SQL related lint errors directly in VSCode.
+
+## Install
+
+Install via the [VSCode marketplace](https://marketplace.visualstudio.com/items?itemName=sbdchd.squawk).
+
+## Install
+
+### From online marketplace
+
+Open the [online marketplace listing](https://marketplace.visualstudio.com/items?itemName=sbdchd.squawk) for Squawk and click "Install". Follow the prompts to open VSCode and install Squawk.
+
+### From VSCode
+
+In VSCode, type `CMD`+`P`, run `Extensions: Install Extensions`, search for `sbdchd.squawk` and click install.
+
+### From Github release
+
+Download the extension package from the [latest Github release](https://github.com/sbdchd/squawk/releases/latest) and run `code --install-extension squawk-*.vsix`
+
+### From source
+
+With `vsce` installed from NPM (`npm install -g @vscode/vsce`), clone [this repo](https://github.com/sbdchd/vscode-squawk) and run `vsce package`. Install the resulting package with `code --install-extension squawk-*.vsix`
+
+## Dev
 
 Make sure you're on a vscode version >= the one defined in the `package.json`,
 otherwise the extension development host won't load the extension.

squawk-vscode/package.json

@@ -13,7 +13,6 @@
   "engines": {
     "vscode": "^1.101.0"
   },
-  "preview": true,
   "keywords": [
     "postgres",
     "postgreSQL",