bumped dependencies + added docstring to main mvr reader func

Author: Jannik-Hm

go.mod

@@ -3,9 +3,9 @@ module github.com/Patch2PDF/MVR-Parser
 go 1.25.4
 
 require (
-	github.com/Patch2PDF/GDTF-Mesh-Reader v1.1.1
-	github.com/Patch2PDF/GDTF-Parser v0.2.0
-	golang.org/x/sync v0.18.0
+	github.com/Patch2PDF/GDTF-Mesh-Reader v1.1.2
+	github.com/Patch2PDF/GDTF-Parser v0.2.1
+	golang.org/x/sync v0.19.0
 )
 
 require github.com/qmuntal/gltf v0.28.0 // indirect

go.sum

@@ -1,10 +1,10 @@
-github.com/Patch2PDF/GDTF-Mesh-Reader v1.1.1 h1:yPk/a1vdq5AwzRIEh82AOz44F/DDXVJL4CO48gGiPjg=
-github.com/Patch2PDF/GDTF-Mesh-Reader v1.1.1/go.mod h1:4Uipj5UA1HhD3v032aSnEFlpItN80UY5zKB15mIeVwQ=
-github.com/Patch2PDF/GDTF-Parser v0.2.0 h1:DMC4CHsSgi11Czu6ynub+RGdHNAV2zpCgTkHp1vjAG0=
-github.com/Patch2PDF/GDTF-Parser v0.2.0/go.mod h1:kv0zDACUKWzixjjR8ZAeVyO+9jzig7zcTE10YTRBJPU=
+github.com/Patch2PDF/GDTF-Mesh-Reader v1.1.2 h1:4LHeQjH+cwRoXuv+O4X9YoJaZAO/DihGGN5t3jVIFFk=
+github.com/Patch2PDF/GDTF-Mesh-Reader v1.1.2/go.mod h1:4Uipj5UA1HhD3v032aSnEFlpItN80UY5zKB15mIeVwQ=
+github.com/Patch2PDF/GDTF-Parser v0.2.1 h1:FCyzL52Tx+wiS/NFLGbXgQSFSmc27evi8rOKfucBh5I=
+github.com/Patch2PDF/GDTF-Parser v0.2.1/go.mod h1:sXYpcmWKjVBL0JuRWyHwSFHRGzx6kex+HaS/vEPLZ2Y=
 github.com/go-test/deep v1.0.1 h1:UQhStjbkDClarlmv0am7OXXO4/GaPdCGiUiMTvi28sg=
 github.com/go-test/deep v1.0.1/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA=
 github.com/qmuntal/gltf v0.28.0 h1:C4A1temWMPtcI2+qNfpfRq8FEJxoBGUN3ZZM8BCc+xU=
 github.com/qmuntal/gltf v0.28.0/go.mod h1:YoXZOt0Nc0kIfSKOLZIRoV4FycdC+GzE+3JgiAGYoMs=
-golang.org/x/sync v0.18.0 h1:kr88TuHDroi+UVf+0hZnirlk8o8T+4MrK6mr60WkH/I=
-golang.org/x/sync v0.18.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=
+golang.org/x/sync v0.19.0 h1:vV+1eWNmZ5geRlYjzm2adRgW2/mcpevXNg50YZtPCE4=
+golang.org/x/sync v0.19.0/go.mod h1:9KTHXmSnoGruLpwFjVSX0lNNA75CykiMECbovNTZqGI=

mvr-parser.go

@@ -12,10 +12,13 @@ import (
 	MVRTypes "github.com/Patch2PDF/MVR-Parser/pkg/types"
 )
 
+// Takes a `.mvr` file zip reader and parses it, according to the given config
+//
+// may contain an entire mesh model of the stage, if configured as such
 func ParseMVRZipReader(zipfile *zip.Reader, config MVRTypes.MVRParserConfig) (*MVRTypes.GeneralSceneDescription, error) {
 	var mvrData MVRXML.GeneralSceneDescription
 
-	// TODO: docs + tests + readme
+	// TODO: docs + tests
 
 	// put all files in zip into the filemap
 	var fileMap map[string]*zip.File = make(map[string]*zip.File)