@@ -1,20 +1,21 @@
1−## yaml
1+# YAML Haskell Library
22
3−[](https://travis-ci.org/snoyberg/yaml)
4−[](https://ci.appveyor.com/project/snoyberg/yaml/branch/master)
3+This project contains two haskell packages: `yaml` for higher-level parsing and writing of yaml documents, and `libyaml`
4+for lower-level event-based streaming.
55
6−Provides support for parsing and emitting Yaml documents.
6+## `yaml` Package
77
8−This project includes a `libyaml` package, which has the [full libyaml C library version 0.2.1 by Kirill Simonov](https://github.com/yaml/libyaml) in the package so you don't need to worry about any non-Haskell dependencies.
8+`yaml` provides a high-level interface based around the JSON datatypes provided by the `aeson` package. This allows
9+using JSON and YAML interchangeably in your code with the `aeson` typeclasses. See the
10+[yaml README](https://github.com/snoyberg/yaml/tree/master/libyaml/README.md) for more details.
911
10−The project is broken down into two primary packages/modules. `yaml` contains `Data.Yaml`, which provides a high-level interface based around the JSON datatypes provided by the `aeson` package. `libyaml` contains `Text.Libyaml`, which provides a lower-level, streaming interface. For most users, `yaml` and `Data.Yaml` is recommended.
12+## `libyaml` Package
1113
12−### Examples
14+`libyaml` is a wrapper over the libyaml C library (and includes the source so no external library is needed). It is an
15+event-based streaming API. See the [libyaml README](https://github.com/snoyberg/yaml/tree/master/libyaml/README.md) for
16+more details.
1317
14−Usage examples can be found in the `Data.Yaml` documentation or in the [examples](https://github.com/snoyberg/yaml/tree/master/examples) directory.
18+## License
1519
16−### Additional `yaml` modules
17−
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 parsing an rendering, as opposed to just using the aeson typeclass and datatype system for parsing and rendering.
20−* `Data.Yaml.Aeson` is currently a re-export of `Data.Yaml` to explicitly choose to use the aeson-compatible API.
20+This project is licensed with the BSD 3-Clause license. Copies of the license can be found in both the `yaml` and
21+`libyaml` subdirectories