Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
petlack committed Jul 12, 2024
1 parent e3fa2e8 commit 3bbb837
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,14 @@
- [Examples](#examples)
- [Secret stored in environment variable](#secret-stored-in-environment-variable)
- [Secret stored in file](#secret-stored-in-file)
- [Using Unsafe Secret Value](#using-unsafe-secret-value)
- [Pass secret as an argument](#pass-secret-as-an-argument)
- [Usage with `pass`](#usage-with-pass)
- [Integration with `qrencode`](#integration-with-qrencode)
- [Installation](#installation)
- [Alpine](#alpine)
- [Archlinux](#archlinux)
- [Ubuntu/Debian](#ubuntudebian)
- [Other](#other)
- [Build from source](#build-from-source)
- [Install release binary](#install-release-binary)
<!--toc:end-->

## Usage
Expand Down Expand Up @@ -76,7 +74,7 @@ echo "mysecret" > ./secret.plaintext
dotp get --secret-file ./secret.plaintext
```

### Using Unsafe Secret Value
### Pass secret as an argument
Directly provide the secret as an argument (not recommended for production use):
```bash
dotp get --secret-unsafe-value "mysecret"
Expand Down Expand Up @@ -148,15 +146,15 @@ sudo dpkg -i dotp_0.0.1.20240712.02-1_amd64.deb
```

### Other
#### Build from source
**Build from source**
Make sure you have [Go installed](https://go.dev/doc/install)
```bash
git clone https://github.com/petlack/dotp && cd dotp || return
go build .
install -m 755 dotp /usr/local/bin/dotp
```

#### Install release binary
**Install release binary**
Head to the [Releases](https://github.com/petlack/dotp/releases) section and download the latest binary for your architecture.
Example:
```bash
Expand Down

0 comments on commit 3bbb837

Please sign in to comment.