Skip to content

Commit cddc7e4

Browse files
committed
Update README.md
1 parent 890f9db commit cddc7e4

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,33 @@ gem "serverkit-mise"
1414

1515
## Usage
1616

17-
TODO: Write usage instructions here
17+
### Prerequisites
18+
19+
- Ensure you have [serverkit](https://github.com/serverkit/serverkit) gem installed
20+
- Ensure you have [mise](https://github.com/jdx/mise) installed on your system
21+
22+
### Basic Example
23+
24+
Create a recipe file that uses the mise resources:
25+
26+
```yaml
27+
# recipe.yml
28+
resources:
29+
# Install Node.js using mise
30+
- type: mise_install
31+
name: node
32+
version: 20.10.0
33+
# Install Ruby and set it as global
34+
- type: mise_use
35+
name: ruby
36+
version: 3.3.0
37+
```
38+
39+
Then apply your recipe with Serverkit:
40+
41+
```console
42+
$ serverkit apply recipe.yml
43+
```
1844

1945
## Resource
2046

0 commit comments

Comments
 (0)