Skip to content

additional readme improvements #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
drduh merged 2 commits into from
Apr 14, 2025
Merged

additional readme improvements #14

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af071e5
grammar
drduh Apr 13, 2025
df1f502
alert important gnupg identity detail
drduh Apr 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,20 @@
Purse is a based on [drduh/pwd.sh](https://github.com/drduh/pwd.sh).
Purse is a Bash shell script based on [drduh/pwd.sh](https://github.com/drduh/pwd.sh).

Both programs are Bash shell scripts which use [GnuPG](https://www.gnupg.org/) to manage secrets in encrypted text files. Purse is based on asymmetric (public-key) authentication, while [pwd.sh](https://github.com/drduh/pwd.sh) is based on symmetric (passphrase-based) authentication.
Both programs use [GnuPG](https://www.gnupg.org/) to manage secrets in encrypted text files. Purse is based on asymmetric (public-key) authentication, while [pwd.sh](https://github.com/drduh/pwd.sh) is based on symmetric (passphrase-based) authentication.

Purse eliminates the need to remember a passphrase: plug in the YubiKey, enter PIN and touch it to access secrets.
Purse eliminates the need for a passphrase: plug in the YubiKey, enter PIN and touch it to access secrets.

# Install
> [!IMPORTANT]
> A GnuPG identity is required to use Purse - see [drduh/YubiKey-Guide](https://github.com/drduh/YubiKey-Guide) to set one up.

Purse requires a GnuPG identity - see [drduh/YubiKey-Guide](https://github.com/drduh/YubiKey-Guide) to set one up.
# Install

For the latest version, clone the repository or download the script directly:
Purse is available for download from [Releases](https://github.com/drduh/Purse/releases), or directly from GitHub:

```console
git clone https://github.com/drduh/Purse

wget https://github.com/drduh/Purse/blob/master/purse.sh
```

Versioned [Releases](https://github.com/drduh/Purse/releases) are also available.

# Use

Run the script interactively using `./purse.sh` or symlink to a directory in `PATH`:
Expand Down