str4d / rage

A simple, secure and modern file encryption tool (and Rust library) with small explicit keys, no config options, and UNIX-style composability.
https://age-encryption.org/v1
Apache License 2.0
2.68k stars 104 forks source link

UX: I made a good readme! #539

Closed ghost closed 1 month ago

ghost commented 1 month ago

I had issues trying to figure out how to use a key file to encrypt files on my own computer with rage. I did not need recipients, i simply wanted to encrypt or decrypt a file with rage on my own computer- using a key. Your current docs did not explain it good enough. SO, i made a tutorial that aims to instantly empower users to encrypt/decrypt files.

Please see this repo https://github.com/oct125/rage-docs there is only a simple html file in there. Please run the html file from a browser. Why not a readme.md? Because it being an html file, any linux or mac or windows user can open that file with any browser, then cut and paste the commands directly into a terminal.

Feel free to use it however you want- put it in a readme.md or anything you wish. But the info is currently missing from your docs!! If the information in the html file was there when i first downloaded Rage, it would have saved me well over an hour of time trying to figure it out.

I do not like to waste time trying to figure out how an app works. No one does. SO the html file i made serves to instantly empower people.