diff --git a/README.md b/README.md index 765e7a7..7c46fd2 100644 --- a/README.md +++ b/README.md @@ -137,8 +137,13 @@ mdns.QueryReceived += (s, e) => mdns.Start(); ``` -# License -Copyright © 2018 Richard Schneider (makaretu@gmail.com) +## Related projects + +- [net-dns](https://github.com/richardschneider/net-dns) - DNS data model and Name Server with serializer for the wire and master file format +- [net-udns](https://github.com/richardschneider/net-udns) - client for unicast DNS, DNS over HTTPS (DOH) and DNS over TLS (DOT) + +## License +Copyright © 2018-2019 Richard Schneider (makaretu@gmail.com) The package is licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php "Read more about the MIT license form") license. Refer to the [LICENSE](https://github.com/richardschneider/net-mdns/blob/master/LICENSE) file for more information. diff --git a/doc/articles/intro.md b/doc/articles/intro.md index 27bccb2..3e598a7 100644 --- a/doc/articles/intro.md +++ b/doc/articles/intro.md @@ -8,13 +8,23 @@ It conforms to The above RFCs are commonly referred to as [Bonjour](https://developer.apple.com/bonjour/) or [Zero Config](http://www.zeroconf.org/). +## Multicast Service + The [MulticastService](ms.md) is used to send DNS [queries](xref:Makaretu.Dns.MulticastService.SendQuery*) and [answers](xref:Makaretu.Dns.MulticastService.SendAnswer*) over the link local network. It also listens for DNS [Messages](xref:Makaretu.Dns.Message) and raises either the [QueryReceived](xref:Makaretu.Dns.MulticastService.QueryReceived) or [AnswerReceived](xref:Makaretu.Dns.MulticastService.AnswerReceived) event. +## Service Discovery + The [ServiceDiscovery](sd.md) is used to find services and service instances on the network. To advertise a service, simply create a [ServiceProfile](xref:Makaretu.Dns.ServiceProfile) and then [Advertise](xref:Makaretu.Dns.ServiceDiscovery.Advertise*) it. Any queries for the service or service instance will be answered with information from the profile. + + +## Related projects + +- [net-dns](https://github.com/richardschneider/net-dns) - DNS data model and Name Server with serializer for the wire and master file format +- [net-udns](https://github.com/richardschneider/net-udns) - client for unicast DNS, DNS over HTTPS (DOH) and DNS over TLS (DOT) diff --git a/doc/articles/sd.md b/doc/articles/sd.md index aab7d43..c01aefa 100644 --- a/doc/articles/sd.md +++ b/doc/articles/sd.md @@ -50,5 +50,4 @@ using Makaretu.Dns; var profile = new ServiceProfile("x", "_myservice._udp", 1024); var sd = new ServiceDiscovery(); sd.Advertise(profile); - ``` \ No newline at end of file