Browse Source

Added README file.

Gustavo Niemeyer 12 years ago
parent
commit
8eba062837
1 changed files with 15 additions and 0 deletions
  1. 15 0
      README.md

+ 15 - 0
README.md

@@ -0,0 +1,15 @@
+# YAML support for the Go language
+
+This package is a pure port of the [libyaml](http://pyyaml.org/wiki/LibYAML)
+C library for the Go language.
+
+Import path
+-----------
+
+The yaml package should be imported as:
+
+  * [gonuts.org/v1/yaml](gonuts.org/v1/yaml)
+
+This URL works with "go get", and it also leads to the package documentation
+if opened with a browser. The package API for yaml v1 will remain stable as
+described in [gonuts.org](gonuts.org).