diff --git a/README.md b/README.md index 71f8f3f..038cb87 100644 --- a/README.md +++ b/README.md @@ -17,15 +17,28 @@ To integrate with the Copilot Language Server, download the latest release from npm install @github/copilot-language-server ``` -To run the language server, platform-specific binaries are available in the `native` directory of the npm package. For +To run the language server, platform-specific binaries are available as separate +packages included as optional dependencies. For example, [`@github/copilot-language-server-darwin-arm64`](https://www.npmjs.com/package/@github/copilot-language-server-darwin-arm64), for macOS on arm64: example, for macOS on arm64: ```sh -./node_modules/@github/copilot-language-server/native/darwin-arm64/copilot-language-server --version +./node_modules/@github/copilot-language-server-darwin-arm64/copilot-language-server --version +``` + +If repackaging the language server, all platform-specific binaries are available +in the releases: https://github.com/github/copilot-language-server-release/releases +For example, to download a zip of all of the binaries together: + +``` +gh release download -R github/copilot-language-server-release -p 'copilot-language-server-native-*' ``` Or you can use [Node.js](https://nodejs.org/en/download/) version 20.8 or later: +```sh +npx @github/copilot-language-server --version +``` + ```sh node ./node_modules/@github/copilot-language-server/dist/language-server.js --version ``` @@ -309,3 +322,10 @@ The client may be sent [`window/showMessageRequest`](https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#window_showMessage) requests. Support for these messages is essential as they are used for important notifications including account and billing. + + +--- + +## License + +Distributed under the MIT license. See LICENSE for details.