Add package documentation and examples

example_test.go

@@ -0,0 +1,58 @@
+package rdns_test
+
+import (
+	"fmt"
+
+	rdns "github.com/folbricht/routedns"
+	"github.com/miekg/dns"
+)
+
+func Example_resolver() {
+	// Define resolver
+	r := rdns.NewDoTClient("dns.google:853")
+
+	// Build a query
+	q := new(dns.Msg)
+	q.SetQuestion("google.com.", dns.TypeA)
+
+	// Resolve the query
+	a, _ := r.Resolve(q)
+	fmt.Println(a)
+}
+
+func Example_group() {
+	// Define resolvers
+	r1 := rdns.NewDNSClient("8.8.8.8:53", "udp")
+	r2 := rdns.NewDNSClient("8.8.4.4:53", "udp")
+
+	// Combine them int a group that does round-robin over the two resolvers
+	g := rdns.NewRoundRobin(r1, r2)
+
+	// Build a query
+	q := new(dns.Msg)
+	q.SetQuestion("google.com.", dns.TypeA)
+
+	// Resolve the query
+	a, _ := g.Resolve(q)
+	fmt.Println(a)
+}
+
+func Example_router() {
+	// Define resolvers
+	google := rdns.NewDNSClient("8.8.8.8:53", "udp")
+	cloudflare := rdns.NewDNSClient("1.1.1.1:53", "udp")
+
+	// Build a router that will send all "*.cloudflare.com" to the cloudflare
+	// resolvber while everything else goes to the google resolver (default)
+	r := rdns.NewRouter()
+	r.Add(`\.cloudflare\.com\.$`, "", cloudflare)
+	r.Add("", "", google)
+
+	// Build a query
+	q := new(dns.Msg)
+	q.SetQuestion("www.cloudflare.com.", dns.TypeA)
+
+	// Resolve the query
+	a, _ := r.Resolve(q)
+	fmt.Println(a)
+}