@@ -3,19 +3,21 @@
3Provides support for parsing and emitting Yaml documents.
3Provides support for parsing and emitting Yaml documents.
5This package includes the [full libyaml C library version 0.1.5 by Kirill
5This package includes the [full libyaml C library version 0.1.5 by Kirill
6−Simonov](http://pyyaml.org/wiki/LibYAML) in the package so you
6+Simonov](http://pyyaml.org/wiki/LibYAML) in the package so you don't need to
7−don't need to worry about any non-Haskell dependencies.
7+worry about any non-Haskell dependencies.
9−The package is broken down into two primary modules.
9+The package is broken down into two primary modules. `Data.Yaml` provides a
10−"Data.Yaml" provides a high-level interface based
11−around the JSON datatypes provided by the @aeson@
10+high-level interface based around the JSON datatypes provided by the `aeson`
12−package. "Text.Libyaml" provides a lower-level,
11+package. `Text.Libyaml` provides a lower-level, streaming interface. For most
13−streaming interface. For most users, "Data.Yaml" is recommended.
12+users, `Data.Yaml` is recommended.
15−Usage examples can be found in the "Data.Yaml" documentation.
14+Usage examples can be found in the `Data.Yaml` documentation.
17Additional modules:
16Additional modules:
19−* Data.Yaml.Include supports adding `!include` directives to your YAML files.
18+* `Data.Yaml.Include` supports adding `!include` directives to your YAML files.
19+* `Data.Yaml.Builder` and `Data.Yaml.Parser` allow more fine-grained control of
20−* 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.
20+ parsing an rendering, as opposed to just using the aeson typeclass and
21+ datatype system for parsing and rendering.
21−* Data.Yaml.Aeson is currently a re-export of Data.Yaml to explicitly choose to use the aeson-compatible API.
22+* `Data.Yaml.Aeson` is currently a re-export of `Data.Yaml` to explicitly
23+ choose to use the aeson-compatible API.