Skip to content

Commit b627b5a

Browse files
authored
Merge pull request #18 from junhsonjb/jjb-readme-better-install-steps
better install step
2 parents 88a40db + fe4e5ab commit b627b5a

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ cargo build --release
2626
cargo run -- -V
2727
```
2828

29-
### (Optional) Aliasing
29+
### (Optional) Local Cargo Install
3030
Since `dotsec` currently has to be built from source, users will need to run the program in the following manner:
3131
```bash
3232
cargo run -- <command> <args>
3333
```
3434

35-
This is a lot to type. The project is planned to be published in the short-term, but in the meantime we can use an alias as a workaround:
35+
This is a lot to type. The project is planned to be published in the short-term, but in the meantime we can use cargo to setup the binary:
3636
```bash
37-
alias ds="cargo run --" # `ds` is the name of the binary
37+
# in the project root (`dotsec/`)
38+
cargo install --path .
3839
```
39-
Run the above line, or add it to your `bashrc` (or the config for whichever shell you use) to make it persistent.
4040

4141
## 🔐 Security
4242
`dotsec` uses [ChaCha20-Poly1305](https://github.com/RustCrypto/AEADs/tree/master/chacha20poly1305) to encrypt and decrypt secrets. Keys and values are stored locally on the user's machine using [sled](https://github.com/spacejam/sled).

0 commit comments

Comments
 (0)