Improve docs around Go Modules

nmyk · Sean-Der · commit a1bbddd0d86f · 2020-06-30T20:14:23.000-07:00
adds export `GO111MODULE=on` to examples READMEs when appropriate
diff --git a/README.md b/README.md
@@ -27,8 +27,12 @@ Pion WebRTC v3.0.0 has started! See the [release notes](https://github.com/pion/
 
 Until `v3.0.0` has been tagged using `v2` is suggested. The last `v2` release is [v2.2.17](https://github.com/pion/webrtc/releases/tag/v2.2.17)
 
+[Go Modules](https://blog.golang.org/using-go-modules) are mandatory for using Pion WebRTC. So make sure you set `export GO111MODULE=on`, and explicitly specify `/v2` or `/v3` when importing.
+
 We are actively planning and would love your feedback! Please create GitHub issues or join [the Slack channel](https://pion.ly/slack) to follow development and speak with the maintainers.
 
+----
+
 Pion WebRTC is a pure Go implementation of WebRTC. It has zero non-Go dependencies and no 3rd party Go dependencies. It is designed to follow **[WebRTC API](https://w3c.github.io/webrtc-pc/)**, but may deviate when required.
 See [DESIGN.md](DESIGN.md) for the guiding principals/inspirations of the project.
 
@@ -173,6 +177,7 @@ Check out the **[contributing wiki](https://github.com/pion/webrtc/wiki/Contribu
 * [Somers Matthews](https://github.com/somersbmatthews)
 * [Vitaliy F](https://github.com/funvit)
 * [Ivan Egorov](https://github.com/vany-egorov)
+* [Nick Mykins](https://github.com/nmyk)
 
 ### License
 MIT License - see [LICENSE](LICENSE) for full text
diff --git a/examples/broadcast/README.md b/examples/broadcast/README.md
@@ -6,6 +6,7 @@ This could serve as the building block to building conferencing software, and ot
 ## Instructions
 ### Download broadcast
 ```
+export GO111MODULE=on
 go get github.com/pion/webrtc/v3/examples/broadcast
 ```
 
diff --git a/examples/custom-logger/README.md b/examples/custom-logger/README.md
@@ -6,6 +6,7 @@ users to override this and process messages however they want.
 ## Instructions
 ### Download custom-logger
 ```
+export GO111MODULE=on
 go get github.com/pion/webrtc/v3/examples/custom-logger
 ```
 
diff --git a/examples/data-channels-create/README.md b/examples/data-channels-create/README.md
@@ -4,6 +4,7 @@ data-channels-create is a Pion WebRTC application that shows how you can send/re
 ## Instructions
 ### Download data-channels-create
 ```
+export GO111MODULE=on
 go get github.com/pion/webrtc/v3/examples/data-channels-create
 ```
 
diff --git a/examples/data-channels-detach-create/README.md b/examples/data-channels-detach-create/README.md
@@ -5,6 +5,7 @@ The example mirrors the data-channels-create example.
 
 ## Install
 ```
+export GO111MODULE=on
 go get github.com/pion/webrtc/v3/examples/data-channels-detach-create
 ```
 
diff --git a/examples/data-channels-detach/README.md b/examples/data-channels-detach/README.md
@@ -5,6 +5,7 @@ The example mirrors the data-channels example.
 
 ## Install
 ```
+export GO111MODULE=on
 go get github.com/pion/webrtc/v3/examples/data-channels-detach
 ```
 
diff --git a/examples/data-channels/README.md b/examples/data-channels/README.md
@@ -4,6 +4,7 @@ data-channels is a Pion WebRTC application that shows how you can send/recv Data
 ## Instructions
 ### Download data-channels
 ```
+export GO111MODULE=on
 go get github.com/pion/webrtc/v3/examples/data-channels
 ```
 
diff --git a/examples/insertable-streams/README.md b/examples/insertable-streams/README.md
@@ -14,6 +14,7 @@ ffmpeg -i $INPUT_FILE -g 30 output.ivf
 
 ### Download insertable-streams
 ```
+export GO111MODULE=on
 go get github.com/pion/webrtc/v3/examples/insertable-streams
 ```
 
diff --git a/examples/pion-to-pion/README.md b/examples/pion-to-pion/README.md
@@ -7,6 +7,7 @@ The `answer` side acts like a HTTP server and should therefore be ran first.
 ## Instructions
 First run `answer`:
 ```sh
+export GO111MODULE=on
 go install github.com/pion/webrtc/v3/examples/pion-to-pion/answer
 answer
 ```
diff --git a/examples/play-from-disk/README.md b/examples/play-from-disk/README.md
@@ -10,6 +10,7 @@ ffmpeg -i $INPUT_FILE -c:a libopus -page_duration 20000 -vn output.ogg
 
 ### Download play-from-disk
 ```
+export GO111MODULE=on
 go get github.com/pion/webrtc/v3/examples/play-from-disk
 ```
 
diff --git a/examples/reflect/README.md b/examples/reflect/README.md
@@ -4,6 +4,7 @@ reflect demonstrates how with one PeerConnection you can send video to Pion and
 ## Instructions
 ### Download reflect
 ```
+export GO111MODULE=on
 go get github.com/pion/webrtc/v3/examples/reflect
 ```
 
diff --git a/examples/rtp-forwarder/README.md b/examples/rtp-forwarder/README.md
@@ -4,6 +4,7 @@ rtp-forwarder is a simple application that shows how to forward your webcam/micr
 ## Instructions
 ### Download rtp-forwarder
 ```
+export GO111MODULE=on
 go get github.com/pion/webrtc/v3/examples/rtp-forwarder
 ```
 
diff --git a/examples/rtp-to-webrtc/README.md b/examples/rtp-to-webrtc/README.md
@@ -6,6 +6,7 @@ With this example we have pre-made GStreamer and ffmpeg pipelines, but you can u
 ## Instructions
 ### Download rtp-to-webrtc
 ```
+export GO111MODULE=on
 go get github.com/pion/webrtc/v3/examples/rtp-to-webrtc
 ```
 
diff --git a/examples/save-to-disk/README.md b/examples/save-to-disk/README.md
@@ -6,6 +6,7 @@ If you wish to save H264 to disk checkout out [save-to-webm](https://github.com/
 ## Instructions
 ### Download save-to-disk
 ```
+export GO111MODULE=on
 go get github.com/pion/webrtc/v3/examples/save-to-disk
 ```
 
diff --git a/examples/swap-tracks/README.md b/examples/swap-tracks/README.md
@@ -4,6 +4,7 @@ swap-tracks demonstrates how to swap multiple incoming tracks on a single outgoi
 ## Instructions
 ### Download swap-tracks
 ```
+export GO111MODULE=on
 go get github.com/pion/webrtc/v3/examples/swap-tracks
 ```
 
