Usage Documentation

[isaacdre]

Current documentation on https://docs.rs/fpe/0.2.0/fpe/ is extremely sparse.

The example is difficult to understand and input / outputs are not clear.

suggestions:

• use verbose variable names or include wiki links for reference.
• create a use-case example. If that is already the case, add in comments to show how the existing documented code works (what you're inputing, what key or seed you're using, the encrypted output, and then decryption tasks).

I'm not able to figure out whatever [0xab, 0xcd, 0xef] represents. And so for me, if I want to input say a string with FPE, "Super secret string", I have no clue as to where to start... Do I need to convert this into a BinaryNumeralString somehow? Is this more for FPE of binary files? Would love some detailed description as to what all is going on and how I could potentially use this module, thanks!