Skip to content

Commit

Permalink
Add documentation section to the README.
Browse files Browse the repository at this point in the history
My goal with this is to funnel people towards immediate, quick answers
first; PHP-specific guidance second; and the C documentation (which
contains a lot of technical information but isn't super useful for
PHP developers) next.

If we can keep people off Google/StackOverflow, we're doing a good job.
  • Loading branch information
paragonie-security committed Oct 19, 2019
1 parent e110988 commit 8228b28
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,18 @@ and the slowdown will be greatly reduced.
This is also true of non-Windows 32-bit operating systems, or if somehow PHP
was compiled where `PHP_INT_SIZE` equals `4` instead of `8` (i.e. Linux on i386).

## Documentation

First, you'll want to read the [Libsodium Quick Reference](https://paragonie.com/blog/2017/06/libsodium-quick-reference-quick-comparison-similar-functions-and-which-one-use).
It aims to answer, "Which function should I use for [common problem]?".

If you don't find the answers in the Quick Reference page, check out
[*Using Libsodium in PHP Projects*](https://paragonie.com/book/pecl-libsodium).

Finally, the [official libsodium documentation](https://download.libsodium.org/doc/)
(which was written for the C library, not the PHP library) also contains a lot of
insightful technical information you may find helpful.

## API Coverage

**Recommended reading:** [Libsodium Quick Reference](https://paragonie.com/blog/2017/06/libsodium-quick-reference-quick-comparison-similar-functions-and-which-one-use)
Expand Down Expand Up @@ -323,7 +335,6 @@ was compiled where `PHP_INT_SIZE` equals `4` instead of `8` (i.e. Linux on i386)
`ParagonIE_Sodium_Compat::crypto_pwhash_is_available()`, which returns a
boolean value (`TRUE` or `FALSE`).


### PHPCompatibility Ruleset

For sodium_compat users and that utilize [`PHPCompatibility`](https://github.com/PHPCompatibility/PHPCompatibility)
Expand Down

0 comments on commit 8228b28

Please sign in to comment.