Skip to content

Commit

Permalink
minor README updates (#96)
Browse files Browse the repository at this point in the history
* use badge to link to GoDoc
* remove Go version requirement
  • Loading branch information
marten-seemann committed Sep 10, 2022
1 parent 7260fee commit 189ef9c
Showing 1 changed file with 1 addition and 4 deletions.
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# go-reuseport

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
[![GoDoc](https://godoc.org/github.com/libp2p/go-reuseport?status.svg)](https://godoc.org/github.com/libp2p/go-reuseport)
[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](https://libp2p.io/)
[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](https://webchat.freenode.net/?channels=%23libp2p)
[![codecov](https://codecov.io/gh/libp2p/go-reuseport/branch/master/graph/badge.svg)](https://codecov.io/gh/libp2p/go-reuseport)
[![Travis CI](https://travis-ci.org/libp2p/go-reuseport.svg?branch=master)](https://travis-ci.org/libp2p/go-reuseport)
[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)

**NOTE:** This package REQUIRES go >= 1.11.

This package enables listening and dialing from _the same_ TCP or UDP port.
This means that the following sockopts may be set:

Expand All @@ -17,8 +16,6 @@ SO_REUSEADDR
SO_REUSEPORT
```

- godoc: https://godoc.org/github.com/libp2p/go-reuseport

This is a simple package to help with address reuse. This is particularly
important when attempting to do TCP NAT holepunching, which requires a process
to both Listen and Dial on the same TCP port. This package provides some
Expand Down

0 comments on commit 189ef9c

Please sign in to comment.