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