modified doc

README.adoc

@@ -29,7 +29,7 @@ The package has the following read functions:
 
 Readers can be used by the scanner to read from the scanner.
 tok has the following build-in Reader:
-Any, AnyRune, Between, BetweenAny, Bool, Digit, Fold, Holey, Int, Lit, Map, Match, Opt, Rune, Seq, Times, To, Uint, Wrap, WS, Zom
+Any, AnyFold, AnyRune, At, Between, BetweenAny, Body, Bool, Digit, Fold, Hex, Holey, Int, Janus, Lit, Many, Map, Match, Named, Not, Opt, Past, Rune, Seq, Set, SkipSeq, SkipWSSeq, Times, To, Uint, Wrap, WS, Zom
 
 
 == Mark Types
@@ -40,16 +40,13 @@ can be used to mark a scanner position
 Token::
 can be used to mark a range of the scanner
 
-Value::
-can be used tag a Token with addition information
-
 Segment::
-groups a value with the corresponding sub string
+can be used tag a Token with addition information
 
 == Grammar
 
-A grammar is a Reader that has RuleReader that are connected.
-Check the grammar for JSON in the gramar package.
+A grammar is a Reader that has connected Rules.
+Check the grammar package with different grammars, like JSOM, MXT and Lua.
 
 == Graph
 
@@ -59,4 +56,13 @@ With the FlameStack function is it possible to generate a string that can be use
 [source,shell]
 ----
 $ flamegraph.pl flame.stack > graph.svg 
-----
+----
+
+== Tracker
+
+A Tracker can be coupled with a Scannar and track the movemend.
+Basket is a Tracker und can be used to Pick-Up Elements that where read by the Parser.
+
+== Log
+
+A Log can be used to monitor and log the movemend in a Reader graph.

tracker.go

@@ -4,18 +4,20 @@ import (
 	"strings"
 )
 
-// Tracker
+// Tracker is an interface that can be coupled with a Scannar and track the movemend.
 type Tracker interface {
 	Update(m Marker)
 }
 
-// Returns a new empty Basket that is set as Tracker on the scanner.
+// Returns a new empty Basket that is coupled as Tracker on the scanner.
 func (s *Scanner) NewBasket() *Basket {
 	b := &Basket{}
 	s.Tracker = b
 	return b
 }
 
+// Returns a new empty Basket that is coupled as Tracker on the scanner.
+// Each Rule that matches picks the Segment to the Basket.
 func (s *Scanner) NewBasketFor(g Grammar) *Basket {
 	b := &Basket{}
 	b.PickWith(g.Grammar()...)
@@ -30,6 +32,7 @@ type Basket struct {
 	segments []Segment
 }
 
+// Add adds a Segment to the Basket.
 func (b *Basket) Add(seg Segment) {
 	b.segments = append(b.segments, seg)
 }
@@ -45,6 +48,7 @@ func (b *Basket) Update(m Marker) {
 	b.segments = []Segment{}
 }
 
+// Picked returns the picked Segments.
 func (b *Basket) Picked() []Segment {
 	return b.segments
 }