_ ____ ___ _ _ ____
| / ___| / _ \| \ | | _ _ | _ \ __ _ _ __ ___ ___
_ | \___ \| | | | \| | (_|_) | |_) / _` | '__/ __|/ _ \
| |_| |___) | |_| | |\ | _ _ | __/ (_| | | \__ \ __/
\___/|____/ \___/|_| \_| (_|_) |_| \__,_|_| |___/\___|
This is the README for JSON::Parse version 0.31.
JSON::Parse 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::Parse - Read JSON into a Perl variable
JSON means "JavaScript Object Notation" and it is specified in "RFC
4627".
JSON::Parse converts JSON into the nearest equivalent Perl. The
function "parse_json" takes one argument, a string containing JSON,
and returns a Perl reference. The input to "parse_json" must be a
complete JSON structure.
The module differs from the "JSON" module by simplifying the handling
of Unicode. If its input is marked as Unicode characters, the strings
in its output are also marked as Unicode characters.
JSON::Parse also provides two high speed validation functions,
"valid_json" and "assert_valid_json", and a function to read JSON from
a file, "json_file_to_perl".
-----------------------------------------------------------------------------
2. DOCUMENTATION
You can read the documentation for the module online at the following websites:
* http://search.cpan.org/perldoc?JSON::Parse
* http://metacpan.org/release/JSON-Parse
(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::Parse
-----------------------------------------------------------------------------
3. INSTALLATION
This module requires Perl version 5.8.9 or later.
To install the module from CPAN, use
cpan JSON::Parse
If you have the App::cpanminus installer, you may prefer
cpanm JSON::Parse
To install the module from the source file, JSON-Parse-0.31.tar.gz, follow this
sequence of commands:
tar xfz JSON-Parse-0.31.tar.gz
cd JSON-Parse-0.31
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-Parse/issues>,
or if you want to alter the source code of JSON::Parse, try the public
repository on github at
<https://github.com/benkasminbullock/JSON-Parse>.
-----------------------------------------------------------------------------
This README was written on Sun Dec 7 14:46:32 2014.
-----------------------------------------------------------------------------