From 775f3ffdd87c321533678c69542a09634567af05 Mon Sep 17 00:00:00 2001 From: Paragon Initiative Enterprises Date: Wed, 12 Apr 2017 16:13:51 -0400 Subject: [PATCH] Update README to add a note about the new namespaced API. --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index bba502e7..cf260aee 100644 --- a/README.md +++ b/README.md @@ -125,6 +125,11 @@ Generally: If you replace `\Sodium\ ` with `ParagonIE_Sodium_Compat::`, any code already written for the libsodium PHP extension should work with our polyfill without additional code changes. +Since version 0.7.0, we have our own namespaced API (`ParagonIE\Sodium\*`) to allow brevity +in software that uses PHP 5.3+. This is useful if you want to use our file cryptography +features without writing `ParagonIE_Sodium_File` every time. This is not exposed on PHP < 5.3, +so if your project supports PHP < 5.3, use the underscore method instead. + To learn how to use Libsodium, read [*Using Libsodium in PHP Projects*](https://paragonie.com/book/pecl-libsodium). ## Help, Sodium_Compat is Slow! How can I make it fast?