From 614e969e2b29c10d5d5a357346675820c85eb1c3 Mon Sep 17 00:00:00 2001 From: Jason McClellan Date: Mon, 22 Apr 2024 12:05:36 -0400 Subject: [PATCH] Update README to add stability warning for tip of main Fix #183 --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 24f08bc..8c1a351 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,17 @@ The **Arduino Language Server** is the tool that powers the autocompletion of the new [Arduino IDE 2][arduino-ide-repo]. It implements the standard [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) so it can be used with other IDEs as well. +## Use Outside of Arduino IDE + +The Arduino Language Server can be used with any editor that supports the Language Server Protocol. Depending on your IDE, you may need to manually manage its installation. You can do so using `go install`: + +```bash +go install github.com/arduino/arduino-language-server@${VERSION} +``` + +> **NOTE** The `main` branch is **not** considered stable! It is *highly* recommended that you pin your installation (regardless of method) to a stable release. The latest release is +[![Latest Release](https://img.shields.io/github/v/release/arduino/arduino-language-server)](https://github.com/arduino/arduino-language-server/releases/latest). + ## Bugs & Issues High quality bug reports and feature requests are valuable contributions to the project.