Update README

This commit is contained in:
James Eversole 2024-02-16 18:35:12 -06:00
parent b4a5da0ed1
commit 6f684564ed

21
README
View File

@ -1,12 +1,13 @@
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.
STATUS: IT JUST WERKS
DETAILS: We're on Saltine now and nix builds are working.
The documentation that was in this README for setup isn't 100% accurate
anymore, so I removed it. I'm going to add some functions to gracefully
handle the setup of the new keyfile dependency and will create new build
and development documentation in this repo then. Also, I'll start
using Markdown when I redo the docs like a sensible person. Stay tuned!
https://purr.eversole.co
@ -41,13 +42,7 @@ own hardware.
DEPLOYMENT
Use Nix with flakes enabled.
Build binary and run natively:
nix build && ./result/bin/Purr-musl
Build and add Docker image to local registry:
nix build .#purr-docker && docker load < result
Updates to this section coming soon.
DEVELOPMENT & SUPPORT