Skip to content

Commit 37b84e6

Browse files
committed
update README.md
1 parent 22263ed commit 37b84e6

File tree

1 file changed

+11
-21
lines changed

1 file changed

+11
-21
lines changed

README.md

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
1-
# water
1+
[![Build Status](https://travis-ci.org/songgao/water.svg?branch=master)](https://travis-ci.org/songgao/water)
2+
[![GoDoc](https://godoc.org/github.com/songgao/water?status.svg)](https://godoc.org/github.com/songgao/water)
23

3-
`water` is a native Go library for [TUN/TAP](http://en.wikipedia.org/wiki/TUN/TAP) interfaces.
4-
5-
`water` is designed to be simple and efficient. It
6-
7-
* wraps almost only syscalls and uses only Go standard types;
8-
* exposes standard interfaces; plays well with standard packages like `io`, `bufio`, etc..
9-
* does not handle memory management (allocating/destructing slice). It's up to user to decide whether/how to reuse buffers.
10-
11-
~~`water/waterutil` has some useful functions to interpret MAC frame headers and IP packet headers. It also contains some constants such as protocol numbers and ethernet frame types.~~
12-
13-
See https://github.com/songgao/packets for functions for parsing various packets.
4+
`water` is a pure Go package for working with
5+
[TUN/TAP](http://en.wikipedia.org/wiki/TUN/TAP) interfaces. It works well with
6+
Go's standard library and has no external dependency.
147

158
## Supported Platforms
169

@@ -19,15 +12,18 @@ See https://github.com/songgao/packets for functions for parsing various packets
1912
* macOS (point-to-point TUN only)
2013

2114
## Installation
15+
2216
```
2317
go get -u github.com/songgao/water
24-
go get -u github.com/songgao/water/waterutil
2518
```
2619

2720
## Documentation
28-
[http://godoc.org/github.com/songgao/water](http://godoc.org/github.com/songgao/water)
2921

30-
## Example
22+
* [Linux](http://godoc.org/github.com/songgao/water?GOOS=linux)
23+
* [macOS](http://godoc.org/github.com/songgao/water?GOOS=darwin)
24+
* [Windows](http://godoc.org/github.com/songgao/water?GOOS=windows)
25+
26+
## Getting Started
3127

3228
### TAP on Linux:
3329

@@ -234,9 +230,3 @@ If you are going to use multiple TAP devices on the Windows, there is a way to s
234230
},
235231
})
236232
```
237-
238-
## TODO
239-
* tuntaposx for TAP on Darwin
240-
241-
## Alternatives
242-
`tuntap`: [https://code.google.com/p/tuntap/](https://code.google.com/p/tuntap/)

0 commit comments

Comments
 (0)