on master help sign in
Clean up docs, version bump
8274360Michael Snoyman
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 @@
1name: yaml
1name: yaml
2−version: 0.8.9.4
2+version: 0.8.10
3license: BSD3
3license: BSD3
4license-file: LICENSE
4license-file: LICENSE
5author: Michael Snoyman <michael@snoyman.com>, Anton Ageev <antage@gmail.com>,Kirill Simonov
5author: Michael Snoyman <michael@snoyman.com>, Anton Ageev <antage@gmail.com>,Kirill Simonov
6maintainer: Michael Snoyman <michael@snoyman.com>
6maintainer: Michael Snoyman <michael@snoyman.com>
7synopsis: Support for parsing and rendering YAML documents.
7synopsis: Support for parsing and rendering YAML documents.
8−description: Provides support for parsing and emitting Yaml documents.
8+description: Please see the README.md file.
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.
19category: Web
9category: Web
20stability: stable
10stability: stable
21cabal-version: >= 1.8
11cabal-version: >= 1.8
22build-type: Simple
12build-type: Simple
23homepage: http://github.com/snoyberg/yaml/
13homepage: http://github.com/snoyberg/yaml/
24−extra-source-files: c/helper.h,
14+extra-source-files: c/helper.h
25− libyaml/yaml_private.h,
15+ libyaml/yaml_private.h
26− libyaml/yaml.h,
16+ libyaml/yaml.h
27 libyaml/LICENSE
17 libyaml/LICENSE
28 test/largest-string.yaml
18 test/largest-string.yaml
29 test/json.yaml
19 test/json.yaml
@@ -32,6 +22,8 @@ extra-source-files: c/helper.h,
32 test/resources/baz.yaml
22 test/resources/baz.yaml
33 test/resources/loop/foo.yaml
23 test/resources/loop/foo.yaml
34 test/resources/loop/bar.yaml
24 test/resources/loop/bar.yaml
25+ README.md
26+ ChangeLog.md
35
27
36flag no-exe
28flag no-exe
37 description: don't install the yaml2json or json2yaml executables
29 description: don't install the yaml2json or json2yaml executables