diff --git a/README.md b/README.md index 9e9e2b76fae8e52b816354ed174c04cdc6fc1683..82473d90a7438b7e7e074d4b7ba2f640a1658302 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ # b-language-server -A language server implementation for B, using ProB as backend, based on Java/Kotlin +A language server implementation for B, using ProB as backend, based on Java/Kotlin. This language server comes with his +own version of probcli. + +## Usage +After starting the server; either from an IDE via main or by building and executing a shadowjar, a language client can +connect to it via port 55555. + +## Capabilities + +- Calling ProB Java Kernel with additional options +- Options need to be specified by the client; They are requested by the server +- Options are: + * val strictChecks : Boolean = true + * val wdChecks : Boolean = true + * val performanceHints : Boolean = true + * val probHome : String = "DEFAULT" + * val debugMode : Boolean = true + +## Clients + +- VSCode: https://marketplace.visualstudio.com/items?itemName=SeeBasTStick.b-language-extension \ No newline at end of file