From f9c3a40c991a3f489f44e3d96e2aaf793801540a Mon Sep 17 00:00:00 2001 From: James Eversole Date: Sun, 7 May 2023 14:04:25 -0500 Subject: [PATCH] Add README warning that project is currently broken due to a change in crypto libraries --- README | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/README b/README index 7f1d222..0773853 100644 --- a/README +++ b/README @@ -1,8 +1,17 @@ purr ----- +STATUS: BROKEN +DETAILS: Currently unable to decrypt/unencode secrets written to the database. +This broke when converting to Nix because it was learned that the previous +crypto-simple library was out of date and needed to be replaced. Use commit +b4bbf6e5a796d6dfc44ac0a052ec4949d2394927 if you want to build a +working project. + + https://purr.eversole.co -a work-in-progress web application offering customizable password generation and time-limited sharing of secrets. +a work-in-progress web application offering customizable password generation +and time-limited sharing of secrets. TECH STACK @@ -12,15 +21,23 @@ TECH STACK GOALS -- Generate sufficiently memorable but secure passwords for use with accounts that don't offer better authentication methods. -- Share text secrets with others without disclosing the secret in the message itself. +- Generate sufficiently memorable but secure passwords for use with accounts +that don't offer better authentication methods. + +- Share text secrets with others without disclosing the secret in the +message itself. + - Be really cute compared to the competition. + - Provide a minimal and clean interface for generating and sharing passwords. -- Maintain a clean and organized codebase that can be extended to include more utilities than originally anticipated. + +- Maintain a clean and organized codebase that can be extended to include more +utilities than originally anticipated. WHY TRUST YOU? -You shouldn't. This is free and open-source software which you can run on your own hardware. +You shouldn't. This is free and open-source software which you can run on your +own hardware. DEPLOYMENT