Add some comments

registry/registry.go

@@ -1,5 +1,8 @@
 package registry
 
+// The registry provides an interface for service discovery
+// and an abstraction over varying implementations
+// {consul, etcd, zookeeper, ...}
 type Registry interface {
 	Register(*Service, ...RegisterOption) error
 	Deregister(*Service) error
@@ -21,22 +24,27 @@ func NewRegistry(addrs []string, opt ...Option) Registry {
 	return newConsulRegistry(addrs, opt...)
 }
 
+// Register a service node. Additionally supply options such as TTL.
 func Register(s *Service, opts ...RegisterOption) error {
 	return DefaultRegistry.Register(s, opts...)
 }
 
+// Deregister a service node
 func Deregister(s *Service) error {
 	return DefaultRegistry.Deregister(s)
 }
 
+// Retrieve a service. A slice is returned since we separate Name/Version.
 func GetService(name string) ([]*Service, error) {
 	return DefaultRegistry.GetService(name)
 }
 
+// List the services. Only returns service names
 func ListServices() ([]*Service, error) {
 	return DefaultRegistry.ListServices()
 }
 
+// Watch returns a watcher which allows you to track updates to the registry.
 func Watch() (Watcher, error) {
 	return DefaultRegistry.Watch()
 }