diff --git a/handler/handler.go b/handler/handler.go index 47953cd..f45bd23 100644 --- a/handler/handler.go +++ b/handler/handler.go @@ -11,7 +11,15 @@ // // Usage // -// s.AddHandler(func(m *gateway.MessageCreateEvent) {}) +// Handler's usage is similar to discordgo, in that AddHandler expects a +// function with only one argument. The only argument must be a pointer to one +// of the events, or an interface{} which would accept all events. +// +// AddHandler would panic if the handler is invalid. +// +// s.AddHandler(func(m *gateway.MessageCreateEvent) { +// log.Println(m.Author.Username, "said", m.Content) +// }) // package handler diff --git a/state/state.go b/state/state.go index 5861656..2fcb62f 100644 --- a/state/state.go +++ b/state/state.go @@ -1,3 +1,5 @@ +// Package state provides interfaces for a local or remote state, as well as +// abstractions around the REST API and Gateway events. package state import (