on master help sign in
typeable/yaml/README.md
23 lines 1.1 kB history raw
1# YAML Haskell Library
3[![Build Status](https://dev.azure.com/snoyberg/yaml/_apis/build/status/snoyberg.yaml?branchName=master)](https://dev.azure.com/snoyberg/yaml/_build/latest?definitionId=7&branchName=master)
5This project contains two haskell packages: `yaml` for higher-level parsing and writing of yaml documents, and `libyaml`
6for lower-level event-based streaming.
8## `yaml` Package
10`yaml` provides a high-level interface based around the JSON datatypes provided by the `aeson` package. This allows
11using JSON and YAML interchangeably in your code with the `aeson` typeclasses. See the
12[yaml README](https://github.com/snoyberg/yaml/tree/master/yaml/README.md) for more details.
14## `libyaml` Package
16`libyaml` is a wrapper over the libyaml C library (and includes the source so no external library is needed). It is an
17event-based streaming API. See the [libyaml README](https://github.com/snoyberg/yaml/tree/master/libyaml/README.md) for
18more details.
20## License
22This project is licensed with the BSD 3-Clause license. Copies of the license can be found in both the `yaml` and
23`libyaml` subdirectories