on master help sign in
Clean up docs, version bump
commit8274360eb348e291208154f2fb497cf7f16e20d3 authorMichael Snoyman <michael@snoyman.com> dateSun 23 Nov 2014, 12:05 (12 years ago) parent475ba70
4 files changed+29−16
ChangeLog.md+3 README−1 README.md+19 yaml.cabal+7−15
ChangeLog.mdnew file+3
@@ -0,0 +1,3 @@
1+## 0.8.10
2+
3+Add the Data.Yaml.Include module
READMEdeleted−1
@@ -1 +0,0 @@
1−Support for serialising Haskell to and from Yaml.
README.mdnew file+19
@@ -0,0 +1,19 @@
1+## yaml
2+
3+Provides support for parsing and emitting Yaml documents.
4+
5+This 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
7+don't need to worry about any non-Haskell dependencies.
8+
9+The package is broken down into two primary modules.
10+"Data.Yaml" provides a high-level interface based
11+around the JSON datatypes provided by the @aeson@
12+package. "Text.Libyaml" provides a lower-level,
13+streaming interface. For most users, "Data.Yaml" is recommended.
14+
15+Additional modules:
16+
17+* Data.Yaml.Include supports adding `!include` directives to your YAML files.
18+* 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.
19+* Data.Yaml.Aeson is currently a re-export of Data.Yaml to explicitly choose to use the aeson-compatible API.
yaml.cabal+7−15
@@ -1,29 +1,19 @@
11name: yaml
2−version: 0.8.9.4
2+version: 0.8.10
33license: BSD3
44license-file: LICENSE
55author: Michael Snoyman <michael@snoyman.com>, Anton Ageev <antage@gmail.com>,Kirill Simonov
66maintainer: Michael Snoyman <michael@snoyman.com>
77synopsis: Support for parsing and rendering YAML documents.
8−description: Provides support for parsing and emitting Yaml documents.
9− .
10− This package includes the full libyaml C library version 0.1.2 by Kirill
11− Simonov (<http://pyyaml.org/wiki/LibYAML>) in the package so you
12− don't need to worry about any non-Haskell dependencies.
13− .
14− The package is broken down into two modules.
15− "Data.Yaml" provides a high-level interface based
16− around the JSON datatypes provided by the @aeson@
17− package. "Text.Libyaml" provides a lower-level,
18− streaming interface. For most users, "Data.Yaml" is recommended.
8+description: Please see the README.md file.
199category: Web
2010stability: stable
2111cabal-version: >= 1.8
2212build-type: Simple
2313homepage: http://github.com/snoyberg/yaml/
24−extra-source-files: c/helper.h,
25− libyaml/yaml_private.h,
26− libyaml/yaml.h,
14+extra-source-files: c/helper.h
15+ libyaml/yaml_private.h
16+ libyaml/yaml.h
2717 libyaml/LICENSE
2818 test/largest-string.yaml
2919 test/json.yaml
@@ -32,6 +22,8 @@ extra-source-files: c/helper.h,
3222 test/resources/baz.yaml
3323 test/resources/loop/foo.yaml
3424 test/resources/loop/bar.yaml
25+ README.md
26+ ChangeLog.md
3527
3628flag no-exe
3729 description: don't install the yaml2json or json2yaml executables