search

pcrockett / kin-backup

Secure, simple backups for your next of kin
MIT License
3 stars 0 forks source link

Set up readme for backup recipients #6

Closed pcrockett closed 5 years ago

pcrockett commented 5 years ago

We need a readme file for the people who will be receiving a backup from the user. This readme file should have instructions on how to access the data in their backup, as well as a password to decrypt someone else's backup.

It could probably also use a link to this GitHub repo as a side-note. And we probably want to allow the user to edit a template readme file.

My original thought was to make this a plain text file, however I'm tempted to make it a self-contained html file. Plain text may be the most portable, long-term format... but it has usability issues. For example, word wrap issues in crappy default text editors (like notepad.exe). At least in an html file, things can be prettified and displayed somewhat reliably, assuming we don't use any complex CSS.

The html option will probably require parsing markdown, especially if we want to allow the user to edit a readme template. Perhaps using markdown.rs?

pcrockett commented 5 years ago

pulldown-cmark seems to be pretty popular, and pretty solid. Here's how to use it.

pcrockett commented 5 years ago

Thinking it would also be useful to have rust-mustache for the readme template.