Skip to content

Commit

Permalink
More consistent markdown formatting in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
xaviershay committed Feb 27, 2016
1 parent ae29023 commit 6896753
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,21 @@
Provides support for parsing and emitting Yaml documents.

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.
Simonov](http://pyyaml.org/wiki/LibYAML) in the package so you don't need to
worry about any non-Haskell dependencies.

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.
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.

Usage examples can be found in the "Data.Yaml" documentation.
Usage examples can be found in the `Data.Yaml` documentation.

Additional modules:

* Data.Yaml.Include supports adding `!include` directives to your YAML files.
* 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.
* Data.Yaml.Aeson is currently a re-export of Data.Yaml to explicitly choose to use the aeson-compatible API.
* `Data.Yaml.Include` supports adding `!include` directives to your YAML files.
* `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.
* `Data.Yaml.Aeson` is currently a re-export of `Data.Yaml` to explicitly
choose to use the aeson-compatible API.

0 comments on commit 6896753

Please sign in to comment.