2016-08-15 11:21:53 -04:00
# go-multiaddr-net
2014-10-11 01:23:37 -07:00
2019-09-18 16:59:15 -07:00
[](https://protocol.ai)
2016-12-26 15:29:30 -05:00
[](https://github.com/multiformats/multiformats)
[](https://webchat.freenode.net/?channels=%23ipfs)
[](https://github.com/RichardLitt/standard-readme)
2017-03-16 16:07:42 +01:00
[](https://godoc.org/github.com/multiformats/go-multiaddr-net)
2016-12-26 15:29:30 -05:00
[](https://travis-ci.org/multiformats/go-multiaddr-net)
2014-10-11 01:23:37 -07:00
2017-03-16 16:07:42 +01:00
<!--- [](https://codecov.io/github/multiformats/go-multiaddr-net?branch=master)--->
> Multiaddress net tools
2016-08-15 11:21:53 -04:00
2016-12-26 15:29:30 -05:00
This package provides [Multiaddr ](https://github.com/multiformats/go-multiaddr ) specific versions of common functions in [stdlib ](https://github.com/golang/go/tree/master/src )'s `net` package. This means wrappers of standard net symbols like `net.Dial` and `net.Listen` , as well
2016-08-15 11:21:53 -04:00
as conversion to and from `net.Addr` .
## Table of Contents
- [Install ](#install )
- [Usage ](#usage )
- [Maintainers ](#maintainers )
- [Contribute ](#contribute )
- [License ](#license )
## Install
2017-03-16 16:07:42 +01:00
`go-multiaddr-net` is a standard Go module which can be installed with:
2016-08-15 11:21:53 -04:00
```sh
2016-10-14 10:41:42 -04:00
go get github.com/multiformats/go-multiaddr-net
2016-08-15 11:21:53 -04:00
```
2017-03-16 16:07:42 +01:00
Note that `go-multiaddr-net` is packaged with Gx, so it is recommended to use Gx to install and use it (see Usage section).
2016-08-15 11:21:53 -04:00
## Usage
2019-09-18 16:59:15 -07:00
See the docs:
2014-10-11 01:23:37 -07:00
2016-09-19 10:30:07 +08:00
- `multiaddr/net` : https://godoc.org/github.com/multiformats/go-multiaddr-net
- `multiaddr` : https://godoc.org/github.com/multiformats/go-multiaddr
2016-08-15 11:21:53 -04:00
## Contribute
Contributions welcome. Please check out [the issues ](https://github.com/multiformats/go-multiaddr-net/issues ).
Check out our [contributing document ](https://github.com/multiformats/multiformats/blob/master/contributing.md ) for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS [Code of Conduct ](https://github.com/ipfs/community/blob/master/code-of-conduct.md ).
2016-12-26 15:29:30 -05:00
Small note: If editing the README, please conform to the [standard-readme ](https://github.com/RichardLitt/standard-readme ) specification.
2016-08-15 11:21:53 -04:00
## License
2016-12-26 15:29:30 -05:00
[MIT ](LICENSE ) © 2014 Juan Batiz-Benet
