mirror of
https://github.com/waku-org/go-multiaddr.git
synced 2025-02-23 19:48:18 +00:00
68 lines
3.1 KiB
Markdown
68 lines
3.1 KiB
Markdown
# go-multiaddr-net
|
|
|
|
[](http://ipn.io)
|
|
[](https://github.com/multiformats/multiformats)
|
|
[](https://webchat.freenode.net/?channels=%23ipfs)
|
|
[](https://github.com/RichardLitt/standard-readme)
|
|
[](https://godoc.org/github.com/multiformats/go-multiaddr-net)
|
|
[](https://travis-ci.org/multiformats/go-multiaddr-net)
|
|
|
|
<!---[](https://codecov.io/github/multiformats/go-multiaddr-net?branch=master)--->
|
|
|
|
> Multiaddress net tools
|
|
|
|
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
|
|
as conversion to and from `net.Addr`.
|
|
|
|
## Table of Contents
|
|
|
|
- [Install](#install)
|
|
- [Usage](#usage)
|
|
- [Maintainers](#maintainers)
|
|
- [Contribute](#contribute)
|
|
- [License](#license)
|
|
|
|
## Install
|
|
|
|
`go-multiaddr-net` is a standard Go module which can be installed with:
|
|
|
|
```sh
|
|
go get github.com/multiformats/go-multiaddr-net
|
|
```
|
|
|
|
Note that `go-multiaddr-net` is packaged with Gx, so it is recommended to use Gx to install and use it (see Usage section).
|
|
|
|
|
|
## Usage
|
|
|
|
This module is packaged with [Gx](https://github.com/whyrusleeping/gx). In order to use it in your own project do:
|
|
|
|
```sh
|
|
go get -u github.com/whyrusleeping/gx
|
|
go get -u github.com/whyrusleeping/gx-go
|
|
cd <your-project-repository>
|
|
gx init
|
|
gx import github.com/multiformats/go-multiaddr-net
|
|
gx install --global
|
|
gx-go --rewrite
|
|
```
|
|
|
|
Please check [Gx](https://github.com/whyrusleeping/gx) and [Gx-go](https://github.com/whyrusleeping/gx-go) documentation for more information.
|
|
|
|
For further usage, see the docs:
|
|
|
|
- `multiaddr/net`: https://godoc.org/github.com/multiformats/go-multiaddr-net
|
|
- `multiaddr`: https://godoc.org/github.com/multiformats/go-multiaddr
|
|
|
|
## 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).
|
|
|
|
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE) © 2014 Juan Batiz-Benet
|