Improves documentation (#13)

* Documents all env variables and adds an example project

* Adds godoc comments

* Fixed package naming issue

models/token.go

@@ -5,6 +5,7 @@ import (
 	"time"
 )
 
+// Token holds tokens typically used for user activation and password resets
 type Token struct {
 	gorm.Model
 	Value     string
@@ -14,11 +15,14 @@ type Token struct {
 	ExpiresAt time.Time
 }
 
+// HasExpired is a helper function that checks if the current time is after the token expiration time
 func (t Token) HasExpired() bool {
 	return t.ExpiresAt.Before(time.Now())
 }
 
 const (
+	// TokenUserActivation is a constant used to identify tokens used for user activation
 	TokenUserActivation string = "user_activation"
-	TokenPasswordReset  string = "password_reset"
+	// TokenPasswordReset is a constant used to identify tokens used for password resets
+	TokenPasswordReset string = "password_reset"
 )