From 2a731d4603407f713acf6394e36886228466c195 Mon Sep 17 00:00:00 2001
From: Christian Cleberg <hello@cleberg.net>
Date: Sun, 2 Aug 2026 15:29:37 -0500
Subject: convert readme to nfo; relicense to 0bsd

1 file changed, 55 insertions(+)
create mode 100644 README.nfo

(limited to 'README.nfo')

diff --git a/README.nfo b/README.nfo
new file mode 100644
index 0000000..04bbca0
--- /dev/null
+++ b/README.nfo
@@ -0,0 +1,55 @@

+│  R P A S S                                 [ KRZ ]   krz.sh

+WHAT
+  command-line password manager in rust + sqlite. manages accounts
+  and generates random ascii passwords or xkcd-style passphrases.

+  data is encrypted before it's written to the sqlite database using
+  the fernet crate. the key is a random vault.key stored in plaintext,
+  so anyone who can read the key can decrypt the database.
+  password-protecting the key file is not done yet.

+  not production-ready. see TODO.

+USE
+      rpass ARGUMENT [VALUES]

+  arguments:
+  -h  --help                       print the welcome message
+  -n  --new                        create an account
+  -l  --list                       list saved accounts
+  -e  --edit [UUID] [FIELD_NAME]   edit an account
+  -d  --delete [UUID]              delete an account
+  -p  --purge                      purge all accounts, delete the vault

+TODO
+  - edit, delete, and purge accounts
+  - password to protect the key file
+  - test suite
+  - publish to crates.io
+  - clean up dead code and unused imports

+DEVELOP
+      git clone REPO_URL
+      cd REPO

+  local test:

+      cargo build --release
+      ./target/release/REPO --help

+  publish to crates.io:

+      cargo build --release
+      cargo login [API_TOKEN]
+      cargo publish --dry-run
+      cargo publish

+CONTRIBUTING
+  fork, add features, open a pull request.

+│  krz.sh

cgit v1.2.3