summaryrefslogtreecommitdiff
path: root/perl/perl-JSON-MaybeXS/README
diff options
context:
space:
mode:
Diffstat (limited to 'perl/perl-JSON-MaybeXS/README')
-rw-r--r--perl/perl-JSON-MaybeXS/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/perl/perl-JSON-MaybeXS/README b/perl/perl-JSON-MaybeXS/README
new file mode 100644
index 0000000000..bea713aea2
--- /dev/null
+++ b/perl/perl-JSON-MaybeXS/README
@@ -0,0 +1,17 @@
+perl-JSON-MaybeXS (Use Cpanel::JSON::XS with a fallback to
+ JSON::XS and JSON::PP)
+
+This module first checks to see if either Cpanel::JSON::XS or
+JSON::XS is already loaded, in which case it uses that module.
+Otherwise it tries to load Cpanel::JSON::XS, then JSON::XS,
+then JSON::PP in order, and either uses the first module it
+finds or throws an error.
+
+It then exports the encode_json and decode_json functions from
+the loaded module, along with a JSON constant that returns the
+class name for calling new on.
+
+If you're writing fresh code rather than replacing JSON.pm
+usage, you might want to pass options as constructor args
+rather than calling mutators, so we provide our own new method
+that supports that.