Skip to content

Commit

Permalink
doc(vscode): add dedicated readme for the extension
Browse files Browse the repository at this point in the history
  • Loading branch information
dnaka91 committed Feb 6, 2024
1 parent 1dd3ca8 commit 38af273
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 2 deletions.
21 changes: 21 additions & 0 deletions vscode-extension/README.md
Original file line number Diff line number Diff line change
@@ -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 <http://opensource.org/licenses/MIT>).
4 changes: 2 additions & 2 deletions vscode-extension/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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"
},
{
Expand Down

0 comments on commit 38af273

Please sign in to comment.