documentation

Author: e-dard

README.md

@@ -32,7 +32,7 @@ import (
 
 func main() {
 	r := http.NewServeMux()
-	rdb.RegisterHandler("/myroute/", r)
+	netbug.RegisterHandler("/myroute/", r)
 	if err := http.ListenAndServe(":8080", r); err != nil {
 		log.Fatal(err)
 	}
@@ -57,7 +57,7 @@ import (
 
 func main() {
 	r := http.NewServeMux()
-	rdb.RegisterAuthHandler("password", "/myroute/", r)
+	netbug.RegisterAuthHandler("password", "/myroute/", r)
 	if err := http.ListenAndServe(":8080", r); err != nil {
 		log.Fatal(err)
 	}

doc.go

@@ -1,5 +1,5 @@
-// Package netbug provides a http.Handler for executing the various
-// profilers and debug tools in the Go std library.
+// Package netbug provides an http.Handler for executing the various
+// profilers and debug tools in the Go standard library.
 //
 // netbug provides some advantages over the /net/http/pprof and
 // /runtime/pprof packages:
@@ -58,12 +58,14 @@
 //		}
 //	}
 //
-// You can then access the index page via GET /myroute/?token=open%20sesame
+// You can then access the index page via:
+//
+// 	GET /myroute/?token=open%20sesame
 //
 // The package also provides access to the handlers directly, for when
 // you want to, say, wrap them in your own logic. Just be sure that
-// when you use the handlers netbug provides you take care to use
-// `http.StripPrefix` to strip the route you register the handler on.
+// when you use the handlers that netbug provides, you take care to use
+// `http.StripPrefix` to strip the route you registered the handler on.
 // This is because the handlers' logic expect them to be registered on
 // "/".
 //
@@ -76,7 +78,10 @@
 //		"github.com/e-dard/netbug"
 //	)
 //
-// 	func myHandler(h http.Handler) http.Handler {
+//	// h is a handler that you wish to wrap around netbug's handler,
+//	// allowing you to add your own logic (other types of
+//	// authentication for example).
+// 	func h(h http.Handler) http.Handler {
 //		mh := func(w http.ResponseWriter, r *http.Request) {
 //			// Some logic here.
 //			h.ServeHTTP(w, r)
@@ -86,8 +91,14 @@
 //
 //	func main() {
 //		r := http.NewServeMux()
-//		rh := http.StripPrefix("/myroute/", netbug.Handler())
-//		r.Handle("/myroute/", myHandler(rh))
+//
+//		// netbug's handler assumes it's registered on "/", so you need
+//		// to strip any prefix you actually want to register it on, if
+//		// you're not using the netbug.RegisterX functions.
+//		nbH := http.StripPrefix("/myroute/", netbug.Handler())
+//
+//		// Wrap the netbug handler in your own, and register the result.
+//		r.Handle("/myroute/", h(nbH))
 //
 //		if err := http.ListenAndServe(":8080", r); err != nil {
 //			log.Fatal(err)