summaryrefslogtreecommitdiff
path: root/README
blob: f9efb688a76ff2359cf108f6a569f76fd7f33d20 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
       _ ____   ___  _   _         ____                     
      | / ___| / _ \| \ | |  _ _  |  _ \ __ _ _ __ ___  ___ 
   _  | \___ \| | | |  \| | (_|_) | |_) / _` | '__/ __|/ _ \
  | |_| |___) | |_| | |\  |  _ _  |  __/ (_| | |  \__ \  __/
   \___/|____/ \___/|_| \_| (_|_) |_|   \__,_|_|  |___/\___|
                                                            


This is the README for JSON::Parse version 0.62.

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 - Parse JSON

A module for parsing JSON. (JSON means "JavaScript Object Notation"
and it is specified in "RFC 8259".)

JSON::Parse offers the function "parse_json", which takes a string
containing JSON, and returns an equivalent Perl structure. It also
offers validation of JSON via "valid_json", which returns true or
false depending on whether the JSON is correct or not, and
"assert_valid_json", which produces a descriptive fatal error if the
JSON is invalid. A function "read_json" reads JSON from a
file, and there is a safer version of "parse_json" called
"parse_json_safe" which doesn't throw exceptions.

For special cases of parsing, there are also methods "new" and
"parse", which create a JSON parsing object and run it on text. See
"METHODS".

JSON::Parse accepts only UTF-8 as input. See "UTF-8 only" and
"Handling of Unicode".

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

2. DOCUMENTATION

You can read the documentation for the module online at the following
website:

    * http://metacpan.org/release/JSON-Parse

(This link goes 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.62.tar.gz, follow
this sequence of commands:

    tar xfz JSON-Parse-0.62.tar.gz
    cd JSON-Parse-0.62
    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 Sat Jul 16 08:23:59 2022.

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