]> scripts.mit.edu Git - autoinstalls/mediawiki.git/blob - vendor/mustangostang/spyc/README.md
MediaWiki 1.30.2-scripts
[autoinstalls/mediawiki.git] / vendor / mustangostang / spyc / README.md
1 **Spyc** is a YAML loader/dumper written in pure PHP. Given a YAML document, Spyc will return an array that
2 you can use however you see fit. Given an array, Spyc will return a string which contains a YAML document 
3 built from your data.
4
5 **YAML** is an amazingly human friendly and strikingly versatile data serialization language which can be used 
6 for log files, config files, custom protocols, the works. For more information, see http://www.yaml.org.
7
8 Spyc supports YAML 1.0 specification.
9
10 ## Using Spyc
11
12 Using Spyc is trivial:
13
14 ```
15 <?php
16 require_once "spyc.php";
17 $Data = Spyc::YAMLLoad('spyc.yaml');
18 ```
19
20 or (if you prefer functional syntax)
21
22 ```
23 <?php
24 require_once "spyc.php";
25 $Data = spyc_load_file('spyc.yaml');
26 ```
27
28 ## Donations, anyone?
29
30 If you find Spyc useful, I'm accepting Bitcoin donations (who doesn't these days?) at 193bEkLP7zMrNLZm9UdUet4puGD5mQiLai