Skip to content

Commit f841931

Browse files
committed
chore(readme): add update info
1 parent c215c5c commit f841931

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,32 @@
11
# agevault
22

3-
`agevault` is a directory encryption tool using [age](https://github.com/FiloSottile/age) file encryption.
3+
`agevault` is a directory encryption tool using
4+
[age](https://github.com/FiloSottile/age) file encryption.
45

56
It locks/unlocks a vault (directory) with a passphrase-protected identity file.
67

7-
Like age, it features no config options, allowing for a straightforward secure flow.
8+
Like age, it features no config options, allowing for a straightforward secure
9+
flow.
810

911
## Disclaimer
1012

11-
**Use it at your own risk!** (see [LICENSE](https://github.com/ndavd/agevault/blob/main/LICENSE))
13+
**Use it at your own risk!** (see
14+
[LICENSE](https://github.com/ndavd/agevault/blob/main/LICENSE))
1215

13-
Also, this is a project in early-development and hasn't been thoroughly tested. So far, I've tested it on Linux.
16+
Also, this is a project in early-development and hasn't been thoroughly tested.
17+
So far, I've tested it on Linux.
1418

1519
## Installation
1620

17-
Download the pre-build binaries from the [latest release](https://github.com/ndavd/agevault/releases/latest).
21+
Always install the latest release to make sure you have the latest security
22+
improvements and fixes. If the update has the same major version (e.g.
23+
`v1.x.x`), then it's guaranteed to be backwards compatible.
24+
25+
Download the pre-built binaries from the
26+
[latest release](https://github.com/ndavd/agevault/releases/latest).
1827

1928
Or using `go`:
29+
2030
```
2131
$ go install github.com/ndavd/agevault@latest
2232
```
@@ -29,22 +39,29 @@ usage: agevault [vault-name] lock|unlock|keygen
2939
```
3040

3141
Securing `my-vault/`:
42+
3243
1. Generate identity file
44+
3345
```
3446
$ agevault my-vault keygen
3547
create identity passphrase:
3648
confirm identity passphrase:
3749
.age14tpkpl6vexufah8eq5dgrd5zy4xqs4slynh26j5n7gvxs87xhguqwu9zqc.my-vault.key.age CREATED (do not change the filename)
3850
```
51+
3952
2. Lock vault
53+
4054
```
4155
$ agevault my-vault lock
4256
my-vault SECURED with age14tpkpl6vexufah8eq5dgrd5zy4xqs4slynh26j5n7gvxs87xhguqwu9zqc
4357
```
58+
4459
3. Unlock vault
60+
4561
```
4662
$ agevault my-vault unlock
4763
enter passphrase for identity file ".age14tpkpl6vexufah8eq5dgrd5zy4xqs4slynh26j5n7gvxs87xhguqwu9zqc.my-vault.key.age":
4864
my-vault DECRYPTED
4965
```
66+
5067
4. That's it. Do your changes, lock it again, etc.

0 commit comments

Comments
 (0)