       _ ____   ___  _   _          ____                _       
      | / ___| / _ \| \ | |  _ _   / ___|_ __ ___  __ _| |_ ___ 
   _  | \___ \| | | |  \| | (_|_) | |   | '__/ _ \/ _` | __/ _ \
  | |_| |___) | |_| | |\  |  _ _  | |___| | |  __/ (_| | ||  __/
   \___/|____/ \___/|_| \_| (_|_)  \____|_|  \___|\__,_|\__\___|
                                                                


This is the README for JSON::Create version 0.14.

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 - turn a Perl variable into JSON

This module produces JSON out of Perl. It offers a function
"create_json" which converts Perl into JSON using common defaults,
and a customizable object created with "new" where the user can
specify a variety of behaviours. For example, Unicode escaping into
ASCII via "unicode_escape_all", floating point number formatting via
"set_fformat", escaping of slashes (/) with "escape_slash", JSON
serialization of objects with "obj", or boolean handling with
"bool".

In all cases, errors in processing result in a warning and an
undefined return value. This behaviour can be altered with the method
"fatal_errors".

This module is a companion to "JSON::Parse" for parsing JSON into
Perl.

The example programs in this documentation are all found in the
directory "examples/" in the distribution. All the outputs below are
taken from the actual outputs of the example programs.

-----------------------------------------------------------------------------

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.14.tar.gz, follow
this sequence of commands:

    tar xfz JSON-Create-0.14.tar.gz
    cd JSON-Create-0.14
    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 Wed Nov 18 09:55:31 2015.

-----------------------------------------------------------------------------
