Merge pull request #49 from creachadair/gomod

Add basic Go modules support.
ghodss · Feb 12, 2019 · 25d852a · 25d852a
2 parents d411552 + 5496865
commit 25d852a
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 1 deletion.
diff --git a/go.mod b/go.mod
@@ -0,0 +1,3 @@
+module github.com/ghodss/yaml
+
+require gopkg.in/yaml.v2 v2.2.2
diff --git a/go.sum b/go.sum
@@ -0,0 +1,3 @@
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
diff --git a/yaml.go b/yaml.go
@@ -1,4 +1,14 @@
-package yaml
+// Package yaml provides a wrapper around go-yaml designed to enable a better
+// way of handling YAML when marshaling to and from structs.
+//
+// In short, this package first converts YAML to JSON using go-yaml and then
+// uses json.Marshal and json.Unmarshal to convert to or from the struct. This
+// means that it effectively reuses the JSON struct tags as well as the custom
+// JSON methods MarshalJSON and UnmarshalJSON unlike go-yaml.
+//
+// See also http://ghodss.com/2014/the-right-way-to-handle-yaml-in-golang
+//
+package yaml  // import "github.com/ghodss/yaml"
 
 import (
 	"bytes"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		module github.com/ghodss/yaml

		require gopkg.in/yaml.v2 v2.2.2