diff --git a/vscode-extension/README.md b/vscode-extension/README.md new file mode 100644 index 0000000..9d34c94 --- /dev/null +++ b/vscode-extension/README.md @@ -0,0 +1,21 @@ +# 🍲 Mabo - Visual Studio Code Extension + +Data format and schema, with a type system as strong as Rust's. + +This project is currently still in a _pre-alpha_ stage and undergoing many changes until the first alpha release. Nonetheless, it should already be usable from the Rust side but expect breaking changes often. + +For further details about how to get started, the schema language or anything else, please consult the official [project website](https://dnaka91.github.io/mabo/). + +## Using the extension + +Currently this extension doesn't bundle the necessary LSP binary. If you have Rust installed, you can use Cargo to build the LSP: + +```sh +cargo install --git https://github.com/dnaka91/mabo.git mabo-lsp +``` + +Then, make sure the binary is globally accessible by putting the Cargo binary folder to your `$PATH` environment variable. This is usually located at `~/.cargo/bin`. + +## License + +This project is licensed under [MIT License](LICENSE.md) (or ). diff --git a/vscode-extension/package.json b/vscode-extension/package.json index 9f7ec19..5ec093b 100644 --- a/vscode-extension/package.json +++ b/vscode-extension/package.json @@ -1,7 +1,7 @@ { "name": "mabo", "displayName": "Mabo", - "version": "0.1.0", + "version": "0.1.1", "description": "Data format and schema, with a type system as strong as Rust's.", "license": "MIT", "publisher": "dnaka91", @@ -23,7 +23,7 @@ "badges": [ { "url": "https://img.shields.io/github/license/dnaka91/mabo?style=for-the-badge", - "href": "LICENSE.md", + "href": "https://github.com/dnaka91/mabo/blob/main/LICENSE.md", "description": "Project License" }, {