Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
davidsemakula committed Feb 4, 2024
1 parent 3037fe3 commit 05562a2
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

[ink!](https://use.ink/) language support for Visual Studio Code.

[ink!](https://use.ink/) is a programming language used for writing smart contracts for blockchains built with [Substrate](https://substrate.io/).
[ink!](https://use.ink/) is a programming language used for writing smart contracts for blockchains built with
[Substrate](https://substrate.io/).

## Features

Expand All @@ -13,9 +14,17 @@
- hover content - descriptive/informational text for ink! attribute macros and arguments.
- inlay hints - inline type and format information for ink! attribute arguments values (e.g. `u32 | _` for ink! selector).
- signature help - popup information for valid ink! attribute arguments for the current context/cursor position.
- commands - triggers for custom functionality like creating a new ink! project with a contract stub or
restarting/stopping the ink! language server.

## Screenshots

### Commands

![command palette](/images/screenshots/command-palette.png 'command palette')

![status bar commands](/images/screenshots/status-bar-item.png 'status bar commands')

### Completions

![contract completions](/images/screenshots/completion-2.png 'contract completions')
Expand Down Expand Up @@ -90,7 +99,9 @@

## Recommendations

[ink!](https://use.ink/) is built on top of [Rust](https://www.rust-lang.org/), so you'll have a much better experience with both [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) and ink! analyzer enabled.
[ink!](https://use.ink/) is built on top of [Rust](https://www.rust-lang.org/), so you'll have a much better experience
with both [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) and
ink! analyzer enabled.

## Extension Settings

Expand Down

0 comments on commit 05562a2

Please sign in to comment.