From 2f14f54b59d1797100c8dd1b0f3883054543b2d7 Mon Sep 17 00:00:00 2001 From: Jesse Hallam Date: Thu, 20 Jun 2019 09:36:32 -0300 Subject: [PATCH] Clarify Go modules requirements. (#44) For anyone new to Go modules, it's worth adding some clarity on how to use this project in the event it remains located in the `$GOPATH`. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 9bb4af1..0a08b68 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ Alternatively shallow clone the repository to a directory outside of `$GOPATH` m git clone --depth 1 https://github.com/mattermost/mattermost-plugin-sample com.example.my-plugin ``` +Note that this project uses [Go modules](https://github.com/golang/go/wiki/Modules). Be sure to locate the project outside of `$GOPATH`, or allow the use of Go modules within your `$GOPATH` with an `export GO111MODULE=on`. + Edit `plugin.json` with your `id`, `name`, and `description`: ``` {