docs(readme): update programmatic usage example (#39)

Co-authored-by: bastantoine <[email protected]>
princjef · Jun 12, 2021 · da13949 · da13949
1 parent 14797b3
commit da13949
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -159,6 +159,7 @@ import (
 
 	"github.com/princjef/gomarkdoc"
 	"github.com/princjef/gomarkdoc/lang"
+	"github.com/princjef/gomarkdoc/logger"
 )
 
 func main() {
@@ -173,14 +174,15 @@ func main() {
 		// handle error
 	}
 
-	buildPkg, err := build.ImportDir(".", wd, build.ImportComment)
+	buildPkg, err := build.ImportDir(wd, build.ImportComment)
 	if err != nil {
 		// handle error
 	}
 
 	// Create a documentation package from the build representation of our
 	// package.
-	pkg, err := lang.NewPackageFromBuild(buildPkg)
+	log := logger.New(logger.DebugLevel)
+	pkg, err := lang.NewPackageFromBuild(log, buildPkg)
 	if err != nil {
 		// handle error
 	}

diff --git a/doc.go b/doc.go
@@ -180,6 +180,7 @@
 //
 //		"github.com/princjef/gomarkdoc"
 //		"github.com/princjef/gomarkdoc/lang"
+//		"github.com/princjef/gomarkdoc/logger"
 //	)
 //
 //	func main() {
@@ -194,14 +195,15 @@
 //			// handle error
 //		}
 //
-//		buildPkg, err := build.ImportDir(".", wd, build.ImportComment)
+//		buildPkg, err := build.ImportDir(wd, build.ImportComment)
 //		if err != nil {
 //			// handle error
 //		}
 //
 //		// Create a documentation package from the build representation of our
 //		// package.
-//		pkg, err := lang.NewPackageFromBuild(buildPkg)
+//		log := logger.New(logger.DebugLevel)
+//		pkg, err := lang.NewPackageFromBuild(log, buildPkg)
 //		if err != nil {
 //			// handle error
 //		}