Skip to content

Commit 614e969

Browse files
committed
Update README to add stability warning for tip of main
Fix #183
1 parent f4dbb67 commit 614e969

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Diff for: README.md

+11
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@
1010

1111
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.
1212

13+
## Use Outside of Arduino IDE
14+
15+
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`:
16+
17+
```bash
18+
go install github.com/arduino/arduino-language-server@${VERSION}
19+
```
20+
21+
> **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
22+
[![Latest Release](https://img.shields.io/github/v/release/arduino/arduino-language-server)](https://github.com/arduino/arduino-language-server/releases/latest).
23+
1324
## Bugs & Issues
1425

1526
High quality bug reports and feature requests are valuable contributions to the project.

0 commit comments

Comments
 (0)