rust-libp2p/dns/README.md
Jef 5c4aefe457 Remove libp2p- prefix (#152)
* Remove `libp2p-` prefix

* More sed-fu
2018-03-20 14:44:46 +01:00

14 lines
525 B
Markdown

# libp2p-dns
This crate provides the type `DnsConfig` that allows one to resolve the `/dns4/` and `/dns6/`
components of multiaddresses.
## Usage
In order to use this crate, create a `DnsConfig` with one of its constructors and pass it an
implementation of the `Transport` trait.
Whenever we want to dial an address through the `DnsConfig` and that address contains a
`/dns4/` or `/dns6/` component, a DNS resolve will be performed and the component will be
replaced with respectively an `/ip4/` or an `/ip6/` component.