Clean up docs, version bump

snoyberg · Nov 23, 2014 · 8274360 · 8274360
1 parent 475ba70
commit 8274360
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 16 deletions.
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -0,0 +1,3 @@
+## 0.8.10
+
+Add the Data.Yaml.Include module
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+## yaml
+
+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.
+
+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.
+
+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.
diff --git a/yaml.cabal b/yaml.cabal
@@ -1,29 +1,19 @@
 name:            yaml
-version:         0.8.9.4
+version:         0.8.10
 license:         BSD3
 license-file:    LICENSE
 author:          Michael Snoyman <michael@snoyman.com>, Anton Ageev <antage@gmail.com>,Kirill Simonov 
 maintainer:      Michael Snoyman <michael@snoyman.com>
 synopsis:        Support for parsing and rendering YAML documents.
-description:     Provides support for parsing and emitting Yaml documents.
-                 .
-                 This package includes the full libyaml C library version 0.1.2 by Kirill
-                 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 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.
+description:     Please see the README.md file.
 category:        Web
 stability:       stable
 cabal-version:   >= 1.8
 build-type:      Simple
 homepage:        http://github.com/snoyberg/yaml/
-extra-source-files: c/helper.h,
-                    libyaml/yaml_private.h,
-                    libyaml/yaml.h,
+extra-source-files: c/helper.h
+                    libyaml/yaml_private.h
+                    libyaml/yaml.h
                     libyaml/LICENSE
                     test/largest-string.yaml
                     test/json.yaml
@@ -32,6 +22,8 @@ extra-source-files: c/helper.h,
                     test/resources/baz.yaml
                     test/resources/loop/foo.yaml
                     test/resources/loop/bar.yaml
+                    README.md
+                    ChangeLog.md
 
 flag no-exe
   description: don't install the yaml2json or json2yaml executables