From f500031b7874ed34861e1f5e39f26516f142a88b Mon Sep 17 00:00:00 2001
From: Brandur <brandur@brandur.org>
Date: Thu, 24 May 2018 03:43:24 +0200
Subject: [PATCH] Add `go.mod` for aspiring vgo support

Adds a `go.mod` file to the project for aspiring vgo support. As
described in #559, without such a file, vgo will default to the lowest
released major version available, which in our case is `v1.0.3`. The vgo
proposal seems to have been officially accepted, so having support for
it early is a bit of a nicety that we can offer.

The one caveat of this addition is that while vgo users should import
stripe-go like this:

    import (
        "github.com/stripe/stripe-go/v30"
    )

We can't actually recommend this `import` style anywhere in our core
documentation yet (although it's okay to put it in the `README.md` in a
vgo-specific section). This is because the `v30` suffix at the end of
the path isn't a real physical path, but rather just a symbolic one that
vgo knows how to parse and resolve as a tag. Trying to use this import
with convention `go get` will fail.

The good news is that this problem has been acknowledged by the core
team, and there will eventually be a pre-vgo `go get` that understands
how to do basic tag resolution [1]. At some point in the future after
this has become widely available, we can probably switch over to
recommending a single install invocation for vgo and pre-vgo users.

Fixes #559.

[1] https://go-review.googlesource.com/c/go/+/109340
---
 README.md | 16 ++++++++++++++++
 go.mod    |  1 +
 2 files changed, 17 insertions(+)
 create mode 100644 go.mod

diff --git a/README.md b/README.md
index b0de40cf30..a0a76a0c1d 100644
--- a/README.md
+++ b/README.md
@@ -36,6 +36,21 @@ changelog](CHANGELOG) and [API changelog][api-changelog].
 go get github.com/stripe/stripe-go
 ```
 
+Then import the package from your Go code:
+
+``` go
+import "github.com/stripe/stripe-go"
+```
+
+### vgo
+
+If using [vgo], don't `go get` it manually, but do use an `import` statement
+that includes the latest major version:
+
+``` go
+import "github.com/stripe/stripe-go/v30"
+```
+
 ## Documentation
 
 For a comprehensive list of examples, check out the [API
@@ -313,6 +328,7 @@ pull request][pulls].
 [package-management]: https://code.google.com/p/go-wiki/wiki/PackageManagementTools
 [pulls]: https://github.com/stripe/stripe-go/pulls
 [stripe]: https://stripe.com
+[vgo]: https://github.com/golang/vgo
 
 <!--
 # vim: set tw=79:
diff --git a/go.mod b/go.mod
new file mode 100644
index 0000000000..0d5f766523
--- /dev/null
+++ b/go.mod
@@ -0,0 +1 @@
+module "github.com/stripe/stripe-go/v30"