diff options
| author | Stefan Kreutz <mail@skreutz.com> | 2022-05-19 10:31:47 +0200 |
|---|---|---|
| committer | Stefan Kreutz <mail@skreutz.com> | 2022-05-19 10:31:47 +0200 |
| commit | 28a34e33a6b6a2ba6810fd2e366a29bda5e03970 (patch) | |
| tree | 5e8bf2dc0d9a0e88c6e53bfb8b1db4e7abed3806 | |
| parent | 1c16630585b8b60502b8b46da3bd6ed2f1db4b09 (diff) | |
| download | shellpass-28a34e33a6b6a2ba6810fd2e366a29bda5e03970.tar | |
Add README and warning
| -rw-r--r-- | README.md | 20 | ||||
| -rw-r--r-- | shellpass.1 | 3 |
2 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f1cc2c5 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# shellpass + +The shellpass utility is a minimalist password manager for the OpenBSD Korn +shell. + +Warning: This is a toy project. Do not use it to store sensitive information. + +## Install + +Run `make install` as root to install the `shellpass` utility and man page. + +## Release + +Create an annotated tag, and an archive as follows, replacing `0.1.0` with the +current version. + + $ git tag --annotate --message "Version 0.1.0" 0.1.0 + $ git archive --format=tar.gz --prefix=shellpass-0.1.0/ \ + --output shellpass-0.1.0.tar.gz 0.1.0 + diff --git a/shellpass.1 b/shellpass.1 index 92bc3e7..4b26cf5 100644 --- a/shellpass.1 +++ b/shellpass.1 @@ -32,6 +32,9 @@ and .Xr qrencode 1 . Essentially, it provides transparent access to OpenPGP-encrypted text files. .Pp +Warning: This is a toy project. +Do not use it to store sensitive information. +.Pp The commands are as follows: .Bl -tag -width Ds .It Cm generate Ar file |