on 64dfd86 help sign in
typeable/yaml/README.md
19 lines 928 B history raw
1## yaml
3Provides support for parsing and emitting Yaml documents.
5This package includes the [full libyaml C library version 0.1.5 by Kirill
6Simonov](http://pyyaml.org/wiki/LibYAML) in the package so you
7don't need to worry about any non-Haskell dependencies.
9The package is broken down into two primary modules.
10"Data.Yaml" provides a high-level interface based
11around the JSON datatypes provided by the @aeson@
12package. "Text.Libyaml" provides a lower-level,
13streaming interface. For most users, "Data.Yaml" is recommended.
15Additional modules:
17* Data.Yaml.Include supports adding `!include` directives to your YAML files.
18* DAta.Yaml.Builder and Data.Yaml.Parser allow more fine-grained control of parsing an rendering, as opposed to just using the aeson typeclass and datatype system for parsing and rendering.
19* Data.Yaml.Aeson is currently a re-export of Data.Yaml to explicitly choose to use the aeson-compatible API.