chore(docs): initial commit

Author: psteinroe

docs/index.md

@@ -0,0 +1,88 @@
+![Postgres Language Server](images/pls-github.png)
+
+# Postgres Language Server
+
+A collection of language tools and a Language Server Protocol (LSP) implementation for Postgres, focusing on developer experience and reliable SQL tooling.
+
+---
+
+**Source Code**: <a href="https://github.com/supabase-community/postgres_lsp" target="_blank">https://github.com/supabase-community/postgres_lsp</a>
+
+---
+
+## Overview
+
+This project provides a toolchain for Postgres development, built on Postgres' own parser `libpg_query` to ensure 100% syntax compatibility. It is built on a Server-Client architecture with a transport-agnostic design. This means all features can be accessed not only through the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), but also through other interfaces like a CLI, HTTP APIs, or a WebAssembly module. The goal is to make all the great Postgres tooling out there as accessible as possible, and to build anything that is missing ourselves.
+
+Currently, the following features are implemented:
+- Autocompletion
+- Syntax Error Highlighting
+- Type-checking (via `EXPLAIN` error insights)
+- Linter, inspired by [Squawk](https://squawkhq.com)
+
+Our current focus is on refining and enhancing these core features while building a robust and easily accessible infrastructure. For future plans and opportunities to contribute, please check out the issues and discussions. Any contributions are welcome!
+
+## Installation
+
+> [!NOTE]
+> We will update this section once we have published the binaries.
+
+## Configuration
+
+We recommend that you create a `pglt.toml` configuration file for each project. This eliminates the need to repeat the CLI options each time you run a command, and ensures that we use the same configuration in your editor. Some options are also only available from a configuration file. If you are happy with the defaults, you don’t need to create a configuration file. To create the `pglt.toml` file, run the `init` command in the root folder of your project:
+
+```sh
+pglt init
+```
+
+After running the `init` command, you’ll have a new `pglt.toml` file in your directory:
+
+```toml
+[vcs]
+enabled = false
+client_kind = "git"
+use_ignore_file = false
+
+[files]
+ignore = []
+
+[linter]
+enabled = true
+
+[linter.rules]
+recommended = true
+
+[db]
+host = "127.0.0.1"
+port = 5432
+username = "postgres"
+password = "postgres"
+database = "postgres"
+conn_timeout_secs = 10
+```
+
+Make sure to point the database connection settings at your local development database. To see what else can be configured, run `--help`.
+
+## Usage
+
+You can check SQL files using the `check` command:
+
+```sh
+pglt check myfile.sql
+```
+
+Make sure to check out the other options. We will provide guides for specific use cases like linting migration files soon.
+
+## Install an Editor Plugin
+
+We recommend installing an editor plugin to get the most out of Postgres Language Tools.
+
+> [!NOTE]
+> We will update this section once we have published the binaries.
+
+
+## CI Setup
+
+> [!NOTE]
+> We will update this section once we have published the binaries.
+