Skip to content

Commit 65c457b

Browse files
authored
chore: improve readme (#676)
1 parent ff50db4 commit 65c457b

3 files changed

Lines changed: 23 additions & 36 deletions

File tree

README.md

Lines changed: 18 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,36 @@
1-
![Postgres Language Server](/docs/images/pls-github.png)
1+
<div align="center">
2+
<img src="docs/images/pls-github.png" alt="Postgres Language Server" width="80%">
23

3-
# Postgres Language Server
4+
# Postgres Language Server
5+
A collection of language tools and a Language Server Protocol (LSP) implementation for Postgres, focusing on developer experience and reliable SQL tooling.
46

5-
A collection of language tools and a Language Server Protocol (LSP) implementation for Postgres, focusing on developer experience and reliable SQL tooling.
7+
[Documentation](https://pg-language-server.com/latest/) | [Installation](https://pg-language-server.com/latest/getting_started/) | [CLI Releases](https://github.com/supabase-community/postgres-language-server/releases)
68

7-
Docs: [pg-language-server.com](https://pg-language-server.com/)
8-
9-
Install: [instructions](https://pg-language-server.com/#installation)
10-
11-
- [CLI releases](https://github.com/supabase-community/postgres-language-server/releases)
12-
- [VSCode](https://marketplace.visualstudio.com/items?itemName=Supabase.postgrestools)
13-
- [Neovim](https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md#postgres_lsp)
14-
- [Zed](https://github.com/LoamStudios/zed-postgres-language-server)
15-
- [Sublime Text](https://lsp.sublimetext.io/language_servers/#postgresql)
9+
[VSCode](https://marketplace.visualstudio.com/items?itemName=Supabase.postgrestools) | [Cursor](https://open-vsx.org/extension/supabase/postgrestools) | [Neovim](https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md#postgres_lsp) | [Zed](https://github.com/LoamStudios/zed-postgres-language-server) | [Sublime Text](https://lsp.sublimetext.io/language_servers/#postgresql)
10+
</div>
1611

1712
## Overview
13+
1814
LSP Demo | CLI Demo
1915
:-------------------------:|:-------------------------:
2016
![LSP Demo](/docs/images/lsp-demo.gif) | ![CLI Demo](/docs/images/cli-demo.png)
2117

22-
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.
18+
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. All features can be accessed through the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), a CLI, HTTP APIs, and 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.
2319

24-
The following features are implemented:
25-
- Autocompletion
26-
- Hover
27-
- Syntax Diagnostics
28-
- Type-checking (via `EXPLAIN` error insights)
29-
- Formatting
30-
- Database & Migration Linting
31-
- PL/pgSQL Support
20+
The following features are available today:
3221

33-
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!
34-
35-
## Contributors
36-
37-
- [psteinroe](https://github.com/psteinroe)
38-
- [juleswritescode](https://github.com/juleswritescode)
22+
- [Autocompletion & Hover](https://pg-language-server.com/latest/features/editor_features/)
23+
- [Syntax Diagnostics](https://pg-language-server.com/latest/features/syntax_diagnostics/)
24+
- [Type Checking](https://pg-language-server.com/latest/features/type_checking/) (via `EXPLAIN` error insights)
25+
- [Formatting](https://pg-language-server.com/latest/features/formatting/)
26+
- [Migration Linting](https://pg-language-server.com/latest/features/linting/)
27+
- [Database Linting](https://pg-language-server.com/latest/features/database_linting/)
28+
- [PL/pgSQL Support](https://pg-language-server.com/latest/features/plpgsql/)
3929

4030
## Development
4131

42-
### Using Nix
43-
44-
```bash
45-
nix develop
46-
docker-compose up -d
47-
```
48-
49-
### Using Docker
50-
5132
```bash
33+
nix develop # or skip if not using Nix
5234
docker-compose up -d
5335
```
5436

docs/getting_started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ Run `postgres-language-server --help` for all options. The CLI options take prec
8080
The Postgres Language Server is available as an extension in your favorite editors.
8181

8282
- VSCode: The language server is available on the [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=Supabase.postgrestools). It's published from [this repo](https://github.com/supabase-community/postgres-language-server-vscode).
83+
- Cursor: The language server is available on the [Open VSX Registry](https://open-vsx.org/extension/supabase/postgrestools).
8384
- Neovim: You will have to install `nvim-lspconfig`, and follow the [instructions](https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md#postgres_lsp).
8485
- Emacs: The language client is available through [lsp-mode](https://github.com/emacs-lsp/lsp-mode). For more details, refer to their [manual page](https://emacs-lsp.github.io/lsp-mode/page/lsp-postgres/).
8586
- Zed: The language server is available as an Extension. It's published from [this repo](https://github.com/LoamStudios/zed-postgres-language-server).

docs/guides/ide_setup.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@ If the language server isn't working:
6868

6969
The language client is available through [lsp-mode](https://github.com/emacs-lsp/lsp-mode). For more details, refer to their [manual page](https://emacs-lsp.github.io/lsp-mode/page/lsp-postgres/).
7070

71+
## Cursor
72+
73+
The language server is available on the [Open VSX Registry](https://open-vsx.org/extension/supabase/postgrestools). Install it from the extensions panel in Cursor.
74+
7175
## Zed
7276

7377
The language server is available as an Extension. It's published from [this repo](https://github.com/LoamStudios/zed-postgres-language-server).

0 commit comments

Comments
 (0)