From 91a3e47c2e498ad886f58e8dcc7ba66dda558265 Mon Sep 17 00:00:00 2001 From: Matt <85322+mattmassicotte@users.noreply.github.com> Date: Thu, 30 Nov 2023 09:48:14 -0500 Subject: [PATCH] Formatting, clearer references to other docs --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 44a742f..b7ac884 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ -[![License][license badge]][license] +
+ +[![Build Status][build status badge]][build status] [![Platforms][platforms badge]][platforms] [![Documentation][documentation badge]][documentation] +[![Discord][discord badge]][discord] + +
# LanguageClient @@ -10,6 +15,8 @@ This is a Swift library for abstracting and interacting with language servers th This library is all based around the `Server` protocol from LanguageServerProtocol. The idea is to wrap up and expose progressively more-complex behavior. This helps to keep things manageable, while also offering lower-complexity types for less-demanding needs. It was also just the first thing I tried that worked out reasonably well. +Because all the types here conform to `Server`, lots of their functionality is covered by [LanguageServerProtocol][languageserverprotocol]'s documenation. + ### Environment Setting correct environment variables is often critical for a language server. An executable on macOS will **not** inherent the user's shell environment. Capturing shell environment variables is tricky business. Despite its name, `ProcessInfo.processInfo.userEnvironment` captures the `process` environment, not the user's. @@ -22,8 +29,6 @@ The Language Server protocol is stateful. Some message types are order-dependent ## Usage -For details on how to respond to server requests and notifications, check out the [LanguageServerProtocol][languageserverprotocol] library documenation. - ### Local Process This is how you run a local server with not extra funtionality. It uses an extension on the [JSONRPC](https://github.com/ChimeHQ/JSONRPC) `DataChannel` type to start up and communicate with a long-running process. @@ -190,11 +195,13 @@ We'd love to hear from you! Get in touch via an issue or pull request. Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. -[license]: https://opensource.org/licenses/BSD-3-Clause -[license badge]: https://img.shields.io/github/license/ChimeHQ/SwiftTreeSitter +[build status]: https://github.com/ChimeHQ/LanguageClient/actions +[build status badge]: https://github.com/ChimeHQ/LanguageClient/workflows/CI/badge.svg [platforms]: https://swiftpackageindex.com/ChimeHQ/LanguageClient [platforms badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2FChimeHQ%2FLanguageClient%2Fbadge%3Ftype%3Dplatforms [documentation]: https://swiftpackageindex.com/ChimeHQ/LanguageClient/main/documentation [documentation badge]: https://img.shields.io/badge/Documentation-DocC-blue +[discord]: https://discord.gg/esFpX6sErJ +[discord badge]: https://img.shields.io/badge/Discord-purple?logo=Discord&label=Chat&color=%235A64EC [languageserverprotocol]: https://github.com/ChimeHQ/LanguageServerProtocol