added some documentation about the tim.Time type

README.md

@@ -32,24 +32,25 @@ go get github.com/Shixzie/nlp
 You will always begin by creating a NL type calling nlp.New(), the NL type is a 
 Natural Language Processor that owns 3 funcs, RegisterModel(), Learn() and P().
 
-### RegisterModel(i interface{}, samples []string) error
+### RegisterModel(i interface{}, samples []string, ops ...ModelOption) error
 
-RegisterModel takes 2 parameters, an empty struct and a set of samples.
+RegisterModel takes 3 parameters, an empty struct, a set of samples and some options for the model.
 
 The empty struct lets nlp know all possible values inside the text, for example:
 ```go
 type Song struct {
-    Name   string // fields must be exported
-    Artist string
+    Name        string // fields must be exported
+    Artist      string
+    ReleasedAt  time.Time
 }
-err := nl.RegisterModel(Song{}, someSamples)
+err := nl.RegisterModel(Song{}, someSamples, nlp.WithTimeFormat("2006"))
 if err != nil {
 	panic(err)
 }
 // ...
 ```
 
-tells nlp that inside the text may be a Song.Name and a Song.Artist.
+tells nlp that inside the text may be a Song.Name, a Song.Artist and a Song.ReleasedAt.
 
 The samples are the key part about nlp, not just because they set the *limits*
 between *keywords* but also because they will be used to choose which model 
@@ -62,6 +63,7 @@ songSamples := []string{
 	"play {Name} from {Artist}",
 	"play {Name}",
 	"from {Artist} play {Name}",
+    "play something from {ReleasedAt}",
 }
 ```
 
@@ -154,19 +156,21 @@ and then **a pointer to a filled struct with the type used to register the model
 
 ```go
 type Song struct {
-	Name   string
-	Artist string
+	Name       string
+	Artist     string
+    ReleasedAt time.Time
 }
 
 songSamples := []string{
 	"play {Name} by {Artist}",
 	"play {Name} from {Artist}",
 	"play {Name}",
 	"from {Artist} play {Name}",
+    "play something from {ReleasedAt}",
 }
 
 nl := nlp.New()
-err := nl.RegisterModel(Song{}, songSamples)
+err := nl.RegisterModel(Song{}, songSamples, nlp.WithTimeFormat("2006"))
 if err != nil {
 	panic(err)
 }

nlp.go

@@ -91,14 +91,15 @@ type field struct {
 type ModelOption func(*model)
 
 // WithTimeFormat sets the format used in time.Parse(format, val),
-// note that format can't contain any spaces
+// note that format can't contain any spaces, the default is 01-02-2006_3:04pm
 func WithTimeFormat(format string) ModelOption {
 	return func(m *model) {
 		m.timeFormat = strings.Replace(format, " ", "", -1)
 	}
 }
 
-// WithTimeLocation sets the location used in time.ParseInLocation(format, value, loc)
+// WithTimeLocation sets the location used in time.ParseInLocation(format, value, loc),
+// the default is time.Local
 func WithTimeLocation(loc *time.Location) ModelOption {
 	return func(m *model) {
 		if loc != nil {
@@ -108,7 +109,8 @@ func WithTimeLocation(loc *time.Location) ModelOption {
 }
 
 // RegisterModel registers a model i and creates possible patterns
-// from samples.
+// from samples, the default layout when parsing time is 01-02-2006_3:04pm
+// and the default location is time.Local.
 // Samples must have special formatting:
 //
 //	"play {Name} by {Artist}"
@@ -265,7 +267,6 @@ order:
 	}
 
 	// fmt.Printf("orders: %v\n\n", limitsOrder)
-
 	// fmt.Printf("scores: %v\n", scores)
 
 	bestScore, bestMapping := -1, -1