Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 71 lines (47 sloc) 2.236 kB
3bb68b2 @jbarnette CHANGELOG and README cleanup for hoe-git.
jbarnette authored
1 = Psych
ec8ae73 @tenderlove initial commit
authored
2
3bb68b2 @jbarnette CHANGELOG and README cleanup for hoe-git.
jbarnette authored
3 * http://github.com/tenderlove/psych
ec8ae73 @tenderlove initial commit
authored
4
3bb68b2 @jbarnette CHANGELOG and README cleanup for hoe-git.
jbarnette authored
5 == Description
ec8ae73 @tenderlove initial commit
authored
6
589c304 @brookemckim Fixed url to libyaml website.
brookemckim authored
7 Psych is a YAML parser and emitter. Psych leverages libyaml[http://pyyaml.org/wiki/LibYAML]
ed65d02 @nirvdrum It's "its."
nirvdrum authored
8 for its YAML parsing and emitting capabilities. In addition to wrapping
dbf891f @tenderlove more docs
authored
9 libyaml, Psych also knows how to serialize and de-serialize most Ruby objects
10 to and from the YAML format.
ec8ae73 @tenderlove initial commit
authored
11
3bb68b2 @jbarnette CHANGELOG and README cleanup for hoe-git.
jbarnette authored
12 == Examples
ec8ae73 @tenderlove initial commit
authored
13
dbf891f @tenderlove more docs
authored
14 # Load YAML in to a Ruby object
15 Psych.load('--- foo') # => 'foo'
16
17 # Emit YAML from a Ruby object
18 Psych.dump("foo") # => "--- foo\n...\n"
ec8ae73 @tenderlove initial commit
authored
19
3bb68b2 @jbarnette CHANGELOG and README cleanup for hoe-git.
jbarnette authored
20 == Dependencies
ec8ae73 @tenderlove initial commit
authored
21
ff397b1 @tenderlove updating readme
authored
22 * libyaml
ec8ae73 @tenderlove initial commit
authored
23
3bb68b2 @jbarnette CHANGELOG and README cleanup for hoe-git.
jbarnette authored
24 == Installation
ec8ae73 @tenderlove initial commit
authored
25
3e3935b @zzak Install documentation, fixes #91
zzak authored
26 Psych has been included with MRI since 1.9.2,
1561554 @olivernn Update README.rdoc
olivernn authored
27 and is the default YAML parser in 1.9.3.
3e3935b @zzak Install documentation, fixes #91
zzak authored
28
29 If you want a newer gem release of Psych, you can use rubygems:
30
31 gem install psych
32
33 In order to use the gem release in your app,
34 and not the stdlib version, you'll need the following:
35
36 gem 'psych'
37 require 'psych'
38
39 Or if you use Bundler add this to your +Gemfile+:
40
41 gem 'psych'
42
43 JRuby ships with a pure Java implementation of Psych.
44
45 If you're on Rubinius, Psych is available in 1.9 mode, please refer to the
46 {Rubinius Documentation}[http://rubini.us/doc/en/build-system/] for more
47 information on building and 1.9 mode.
ec8ae73 @tenderlove initial commit
authored
48
3bb68b2 @jbarnette CHANGELOG and README cleanup for hoe-git.
jbarnette authored
49 == License
ec8ae73 @tenderlove initial commit
authored
50
3bb68b2 @jbarnette CHANGELOG and README cleanup for hoe-git.
jbarnette authored
51 Copyright 2009 Aaron Patterson, et al.
ec8ae73 @tenderlove initial commit
authored
52
53 Permission is hereby granted, free of charge, to any person obtaining
54 a copy of this software and associated documentation files (the
55 'Software'), to deal in the Software without restriction, including
56 without limitation the rights to use, copy, modify, merge, publish,
57 distribute, sublicense, and/or sell copies of the Software, and to
58 permit persons to whom the Software is furnished to do so, subject to
59 the following conditions:
60
61 The above copyright notice and this permission notice shall be
62 included in all copies or substantial portions of the Software.
63
64 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
65 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
66 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
67 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
68 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
69 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
70 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Something went wrong with that request. Please try again.