_ ____ ___ _ _ ____ _
| / ___| / _ \| \ | | _ _ / ___|_ __ ___ __ _| |_ ___
_ | \___ \| | | | \| | (_|_) | | | '__/ _ \/ _` | __/ _ \
| |_| |___) | |_| | |\ | _ _ | |___| | | __/ (_| | || __/
\___/|____/ \___/|_| \_| (_|_) \____|_| \___|\__,_|\__\___|
This is the README for JSON::Create version 0.22.
JSON::Create is a "module" for the Perl computer programming language, a
library of computer code to install on a computer. This document contains four
sections:
1. About - what the module does
2. Documentation - how to learn more about the module
3. Installation - how to install this module on a computer
4. Help - what to do if you get stuck
-----------------------------------------------------------------------------
1. ABOUT
JSON::Create - fast, minimal, UTF-8-only serialization of data to JSON
JSON::Create encodes Perl variables into the JSON format. It offers
"create_json", which uses common defaults, "create_json_strict",
which accepts only unambiguous inputs, and a customizable object
created with "new" and run with "run" where the user can specify a
variety of behaviours.
JSON::Create aims to provide fast and minimal serialization of data
types. It handles no string encoding except UTF-8. The module supports
serialization of objects and other non-data types via user-defined
callbacks.
Errors in processing result in a warning and an undefined return
value. This behaviour can be altered with the method "fatal_errors".
This module documentation is generated from machine readable code. All
of the example programs in this documentation may be found in the
directory "examples/" in the distribution. All of the example outputs
displayed were generated by running the example programs.
This module is a companion to "JSON::Parse" for parsing JSON into
Perl.
-----------------------------------------------------------------------------
2. DOCUMENTATION
You can read the documentation for the module online at the following websites:
* http://search.cpan.org/perldoc?JSON::Create
* http://metacpan.org/release/JSON-Create
(These links go to the latest version of the module.)
After installing the module, you can read the documentation on your computer
using
perldoc JSON::Create
-----------------------------------------------------------------------------
3. INSTALLATION
This module requires Perl version 5.6.1 or later.
To install the module from CPAN, use
cpan JSON::Create
If you have the App::cpanminus installer, you may prefer
cpanm JSON::Create
To install the module from the source file, JSON-Create-0.22.tar.gz, follow
this sequence of commands:
tar xfz JSON-Create-0.22.tar.gz
cd JSON-Create-0.22
perl Makefile.PL
make
make install
If you want to test the module before installing it, use "make test" after
"make" and before "make install".
-----------------------------------------------------------------------------
4. HELP
To get help with the module, you can email the author, Ben Bullock, at
<bkb@cpan.org>. If you think there is a problem in the module, you can report a
bug at
<https://github.com/benkasminbullock/json-create/issues>,
or if you want to alter the source code of JSON::Create, try the public
repository on github at
<https://github.com/benkasminbullock/json-create>.
-----------------------------------------------------------------------------
This README was written on Fri Jul 15 20:01:08 2016.
-----------------------------------------------------------------------------