diff --git a/README.md b/README.md index b4ad63b..5f5ed8d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# Language support for Cairo +# Language support for Cairo and StarkNet [Cairo](https://www.cairo-lang.org/) language support for VS Code. -This project implements a Cairo language server and VS Code extension to help with writing Cairo programs for StarkNet. +This project implements a Cairo language server and VS Code extension to help with writing Cairo contracts for StarkNet. **Note**: This is an early preview release and is still in active development. @@ -18,14 +18,15 @@ This project implements a Cairo language server and VS Code extension to help wi - Code completion for imports - Hover documentation (minimal for now) -Right-click menu commands to interact with Cairo: -- Compile Cairo program -- Compile StarkNet contract -- Run Cairo program +Right-click menu commands using [Nile](https://github.com/OpenZeppelin/nile): +- Nile - Clean +- Nile - Compile all +- Nile - Compile this contract +- Run tests with pytest ## Setup -1. Follow [Cairo environment setup steps](https://www.cairo-lang.org/docs/quickstart.html). -2. If using a virtual environment, start VS Code from within that terminal according to the instructions in the above link. -3. Install this extension along with [StarkWare's Cairo extension (.vsix file)](https://github.com/starkware-libs/cairo-lang/releases). -4. Open a .cairo file and start editing. +1. Install Nile by following its [Getting started](https://github.com/OpenZeppelin/nile#getting-started) steps, or follow the [Cairo environment setup steps](https://www.cairo-lang.org/docs/quickstart.html). +3. If using a virtual environment, start VS Code from within that terminal according to the instructions [here](https://www.cairo-lang.org/docs/quickstart.html#visual-studio-code-setup). +4. Install this extension along with [StarkWare's Cairo extension (.vsix file)](https://github.com/starkware-libs/cairo-lang/releases). +5. Open a .cairo file and start editing. diff --git a/package.json b/package.json index 8848b5b..27e8a45 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,10 @@ { "name": "cairo-ls", - "displayName": "Language support for Cairo", - "description": "Cairo language support for VS Code", + "displayName": "Language support for Cairo and StarkNet", + "description": "Cairo and StarkNet language support for VS Code", "author": "Eric Lau", "license": "EPL-2.0", - "version": "0.0.12", + "version": "0.0.13", "preview": true, "icon": "images/logo.png", "repository": {