Skip to content

Commit 84996f3

Browse files
committed
docs: Update README with usage instructions
1 parent 1fc5f25 commit 84996f3

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,38 @@
55

66
[Serverkit](https://github.com/serverkit/serverkit) plug-in for [VSCode](https://code.visualstudio.com/).
77

8-
## Install
8+
## Installation
99

1010
```rb
1111
# Gemfile
1212
gem "serverkit-vscode"
1313
```
1414

15+
## Usage
16+
17+
### Prerequisites
18+
19+
- Ensure you have [serverkit](https://github.com/serverkit/serverkit) gem installed
20+
- Ensure you have [VSCode CLI](https://code.visualstudio.com/docs/configure/command-line) installed on your system
21+
22+
### Basic Example
23+
24+
Create a recipe file that uses the vscode resources:
25+
26+
```yaml
27+
# recipe.yml
28+
resources:
29+
# Install GitHub Copilot extension
30+
- type: vscode_package
31+
name: github.copilot
32+
```
33+
34+
Then apply your recipe with Serverkit:
35+
36+
```console
37+
$ serverkit apply recipe.yml
38+
```
39+
1540
## Resource
1641

1742
### vscode_package

0 commit comments

Comments
 (0)