Added description for specifying an interface name for Windows

songgao · Mar 30, 2019 · f7eb3ca · f7eb3ca
1 parent d689e71
commit f7eb3ca
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -11,3 +11,4 @@ yinheli <hi@yinheli.com>
 Paul Querna <pquerna@apache.org>
 Cuong Manh Le <cuong.manhle.vn@gmail.com>
 Neil Alexander <neilalexander@users.noreply.github.com>
+Dmitry Shihovtsev <soffokulus@gmail.com>
diff --git a/README.md b/README.md
@@ -220,6 +220,21 @@ ping 10.1.0.255
 
 You'll see output containing the IPv4 ICMP frame same as the Linux version.
 
+#### Specifying interface name
+
+If you are going to use multiple TAP devices on the Windows, there is a way to specify an interface name to select the exact device that you need:
+
+```go
+	ifce, err := water.New(water.Config{
+		DeviceType: water.TAP,
+		PlatformSpecificParams: water.PlatformSpecificParams{
+			ComponentID:   "tap0901",
+			InterfaceName: "Ethernet 3",
+			Network:       "192.168.1.10/24",
+		},
+	})
+```
+
 ## TODO
 * tuntaposx for TAP on Darwin