diff --git a/README.md b/README.md index 024dd2a..f9fe3de 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ `pbls` is a [Language Server](https://microsoft.github.io/language-server-protocol/) for [protobuf](https://protobuf.dev/). +`pbls` was originally hosted at https://git.sr.ht/~rrc/pbls, but was moved to https://github.com/rcorre/pbls ease contribution. +The sourcehut repo is maintained as a mirror. + # Features - Diagnostics (from `protoc`) @@ -17,7 +20,7 @@ Ensure [`protoc`](https://github.com/protocolbuffers/protobuf#protobuf-compiler- # Installation ``` -cargo install --git https://git.sr.ht/~rrc/pbls +cargo install --git https://github.com/rcorre/pbls ``` Ensure the cargo binary path (usually `~/.cargo/bin`) is on `$PATH`. @@ -61,6 +64,17 @@ language-servers = ['pbls'] formatter = { command = "clang-format" , args = ["--assume-filename=a.proto"]} ``` +You can also enable `pbls` in other languages, allowing you to search for protobuf messages without having a protobuf file open: + +```toml +# ~/.config/helix/languages.toml + +# Search for protobuf symbols in C++ files using S +[[language]] +name = "cpp" +language-servers = [ "clangd", { name = "pbls", only-features = ["workspace-symbols"] } ] +``` + # Similar Projects - [buf-language-server](https://github.com/bufbuild/buf-language-server)