Skip to content

Commit bdbcf5e

Browse files
committed
docs readme.md
1 parent 016ed6c commit bdbcf5e

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Flags:
5050
The inventory configuration for Voidify is inspired by Ansible YAML inventory structure but simplified for ease of use. It consists of two main sections: `Environment` and `hosts`.
5151

5252
- `Environment`: Represents different environments, such as `production` and `development`, where your hosts are grouped.
53-
- `hosts`: Defines individual hosts with user-friendly names, like `mariadb`, which make it easy to identify where you want to connect.
53+
- `hosts`: Defines individual hosts with user-friendly names (alias), like `mariadb`, which make it easy to identify where you want to connect.
5454

5555
Inside each `host`, you need to specify `key: value` pairs, where `key` corresponds to a supported SSH config parameter. Ensure that the `key` is written exactly as it appears in a typical SSH config file. The `value` field holds the value for that key.
5656

@@ -119,7 +119,7 @@ Host grafana
119119
IdentitiesOnly Yes
120120
```
121121

122-
## Instalation
122+
## Installation
123123

124124
Voidify is designed for installation on your workstation, to be executed via your terminal application.
125125

@@ -152,6 +152,7 @@ git clone https://github.com/voidquark/voidify
152152

153153
**Step 2: Download modules to local cache**
154154
```shell
155+
cd voidify
155156
go mod download
156157
```
157158

0 commit comments

Comments
 (0)