Documentation

[defuse]

The documentation shouldn't be a massive comment at the top of the file (that nobody will read anyway).

[paragonie-scott]

We have a couple options:

• The Github Wiki
• Gitbook

I'd like to see what other people prefer working with more.

[goldsky]

I'd suggest Github Wiki.

[Darkheir]

I just discovered this github repository but I'd suggest to use the github wiki for the documentation and create a github page to describe the projet : https://pages.github.com/

[NicolasCARPi]

👍

[wheelsandcogs]

A lot of projects just put example usage in their README which is usually enough for small libraries. A link to example.php would probably be enough to get peeps started.

[wheelsandcogs]

Also, it really needs some basic advice on how to safely store the encryption keys. In real-world usage the ciphertext is going to either be stored between requests or sent across the wire, so the key (or something that can generate the key) is eventually going to have to be stored in a config file / db.

I found #60 but there doesn't seem to be a conclusion?

[defuse]

@sarciszewski We have some things in /doc/ now -- is that some standardized documentation thing?

[paragonie-scott]

It's a start. I wouldn't call it anywhere near complete.

[defuse]

Make sure we document that only PHP >= 5.4 is supported, since that's what we're testing.

(We should only officially support versions that are still security-supported by PHP, but behind-the-scenes we should try to at least not fail catastrophically on older versions. We should have full support for at least whatever version of PHP is in debian oldstable.)