document JSON->true, JSON->false

diff --git a/Changes b/Changes
index 1777327..08d17ae 100644 (file)
--- a/Changes
+++ b/Changes
@@ -1,5 +1,7 @@
 Revision history for JSON-MaybeXS
 
+ - document how to use booleans
+
 1.002002 - 2014-04-23
  - more metadata fiddling, to remove the Cpanel::JSON::XS dependency visible
    to static analyzers (the prequisites at install time remain unchanged)

diff --git a/lib/JSON/MaybeXS.pm b/lib/JSON/MaybeXS.pm
index 4279307..f646237 100644 (file)
--- a/lib/JSON/MaybeXS.pm
+++ b/lib/JSON/MaybeXS.pm
@@ -126,6 +126,14 @@ Since this is a trifle irritating and noticeably un-perlish, we also offer:
 which works equivalently to the above (and in the usual tradition will accept
 a hashref instead of a hash, should you so desire).
 
+=head1 BOOLEANS
+
+To include JSON-aware booleans (C<true>, C<false>) in your data, just do:
+
+    use JSON::MaybeXS;
+    my $true = JSON->true;
+    my $false = JSON->false;
+
 =head1 AUTHOR
 
 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>