Skip to content

Commit 355ea99

Browse files
authored
Merge pull request #25 from junhsonjb/jjb-crates-io-readme
update readme now that project is on crates.io
2 parents eca48f8 + 29b45e8 commit 355ea99

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It's designed for terminal users who want a simple CLI-based secrets manager tha
1313

1414
## 💾 Installation
1515

16-
Currently `dotsec` must be cloned and built from source. One of the short-term goals is to publish the project so that it can be installed on platforms like `brew`, `apt`, and others.
16+
Currently `dotsec` can be built from source or installed via `crates.io`. One of the short-term goals is to publish the project so that it can be installed on platforms like `brew`, `apt`, and others.
1717

1818
### Prerequisites
1919
You'll need [Rust](https://www.rust-lang.org/tools/install) installed.
@@ -23,19 +23,13 @@ You'll need [Rust](https://www.rust-lang.org/tools/install) installed.
2323
git clone https://github.com/junhsonjb/dotsec.git
2424
cd dotsec
2525
cargo build --release
26-
cargo run -- -V
26+
cargo run -- -V # optional: verify that installation was successful
27+
cargo install --path . # optional: install binary under command `ds`
2728
```
2829

29-
### (Optional) Local Cargo Install
30-
Since `dotsec` currently has to be built from source, users will need to run the program in the following manner:
30+
### Install from crates.io
3131
```bash
32-
cargo run -- <command> <args>
33-
```
34-
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:
36-
```bash
37-
# in the project root (`dotsec/`)
38-
cargo install --path .
32+
cargo install dotsec
3933
```
4034

4135
## 🔐 Security

0 commit comments

Comments
 (0)