doc

alaingilbert · Aug 21, 2022 · d11813b · d11813b
1 parent 6508da9
commit d11813b
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/doc/intro.md b/doc/intro.md
@@ -0,0 +1,14 @@
+pkg/ogame
+Define all ogame data structures
+
+pkg/client
+Http client that communicate with ogame server to retrieve html pages
+
+pkg/extractor
+Extract information out of a html page
+
+pkg/parser
+Given an extractor and html page, return a typed page with methods to extract data on that page
+
+pkg/wrapper
+Build logic and utilities using pkg/ogame data structures
diff --git a/pkg/wrapper/gameforge.go b/pkg/wrapper/gameforge.go
@@ -19,7 +19,7 @@ import (
 	"time"
 )
 
-// ogame cookie name for token id
+// TokenCookieName ogame cookie name for token id
 const TokenCookieName = "gf-token-production"
 const ChallengeIDCookieName = "gf-challenge-id"