yggdrasil-network/water
1
0
Fork 0
mirror of https://github.com/yggdrasil-network/water.git synced 2025-05-19 16:35:10 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md (resolves #16)

Browse source
This commit is contained in:
Song Gao 2017-01-22 17:49:06 -08:00
parent 1a3940420d
commit ee9c96d609
1 changed files with 13 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -15,7 +15,7 @@ See https://github.com/songgao/packets for functions for parsing various packets
## Supported Platforms
* Linux
* Windows
* Windows (experimental; APIs might change)
* macOS (point-to-point TUN only)
## Installation
@ -42,7 +42,12 @@ import (
)
func main() {
ifce, err := water.NewTAP("O_O")
config := water.Config{
DeviceType: water.TAP,
}
config.Name = "O_O"
ifce, err := water.New(config)
if err != nil {
log.Fatal(err)
}
@ -101,7 +106,9 @@ import (
)
func main() {
ifce, err := water.NewTUN("")
ifce, err := water.New(water.Config{
DeviceType: water.TUN,
})
if err != nil {
log.Fatal(err)
}
@ -161,7 +168,9 @@ import (
)
func main() {
ifce, err := water.NewTAP("O_O")
ifce, err := water.New(water.Config{
DeviceType: water.TAP,
})
if err != nil {
log.Fatal(err)
}