Skip to content

Commit b146e76

Browse files
committed
Readme edits
1 parent 6d6bf4c commit b146e76

File tree

1 file changed

+15
-25
lines changed

1 file changed

+15
-25
lines changed

README.md

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,28 @@ documentation and diagnostic hovers, and integrations with [Buf][buf] commands.
66

77
## Features
88

9-
- Code navigation: Jump to a symbol's declaration and check references to a symbol.
10-
- Autocompletion: Get code completion for symbols as you code through [IntelliSense][intellisense].
11-
- Syntax highlighting:
12-
- Documentation hovers: Peek at a symbol's documentation
13-
14-
15-
16-
17-
Go-to definition and go-to references for `.proto` symbols.
18-
- Autocompletion: Completion results for `.proto` symbols using [IntelliSense][intellisense].
19-
- Syntax highlighting: Protobuf specific color and styling for code.
20-
- Documentation hovers: Documentation for definitions when hovering a reference.
21-
- Formatting: Formats `.proto` files on-save.
22-
- Diagnostics: Annotations and highlights for build and lint errors.
9+
- **Code navigation and documentation hovers**: Jump to or quickly glance a message or
10+
service's definition.
11+
- **Autocompletion**: Get code completion as you type through [IntelliSense][intellisense].
12+
- **Formatting**: Formats `.proto` files on-save.
13+
- **Syntax highlighting**: Code styling that provides clarity on Protobuf keywords and identifiers.
14+
- **Diagnostics**: Get highlights and feedback on build and lint errors as you code.
2315

2416
![Preview features](./preview.gif)
2517

26-
In addition to integrated editing features, the extension provides commands through the
27-
`buf` CLI. These commands are accessible by opening the [Command Palette][command-palette],
28-
`Ctrl/Cmd+Shift+P`. See the [full list of commands](#commands) provided by this extension.
29-
30-
## Requirements
31-
32-
- Visual Studio Code 1.95 or newer (or editors compatible with VS Code 1.90+ APIs)
18+
This extension doesn't stop at editing: open the [Command Palette][command-palette] (`Ctrl/Cmd+Shift+P`)
19+
to quickly run common tasks through `buf` like `buf generate`. See the [full list of commands](#commands)
20+
provided by this extension.
3321

3422
## Getting Started
3523

36-
[Install the latest version via the VS Code marketplace][vs-code-marketplace].
24+
This extension is requires Visual Studio Code 1.95 or newer (or editors compatible with VS Code 1.95+ APIs).
25+
26+
[Install the latest version via the VS Code marketplace][vs-code-marketplace]. And that's all you need to get started!
3727

38-
You do not need to install the Buf CLI to use this extension. By default, the extension uses
39-
the Buf CLI from your system `$PATH`. If `buf` isn't found on your `$PATH`, the extension
40-
automatically downloads and installs the latest version to its own storage directory.
28+
This extension does not require you to have the Buf CLI already installed. By default, the extension uses
29+
the Buf CLI from your system `$PATH`. If `buf` isn't found on your `$PATH`, the extension automatically
30+
downloads and installs the latest version to its own storage directory.
4131

4232
## Community and Support
4333

0 commit comments

Comments
 (0)