docs: update readme with base plugin

JohannesKaufmann · Nov 4, 2024 · 1947a7f · 1947a7f
1 parent 90318d6
commit 1947a7f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -63,6 +63,7 @@ import (
 	"log"
 
 	"github.com/JohannesKaufmann/html-to-markdown/v2/converter"
+	"github.com/JohannesKaufmann/html-to-markdown/v2/plugin/base"
 	"github.com/JohannesKaufmann/html-to-markdown/v2/plugin/commonmark"
 )
 
@@ -71,6 +72,7 @@ func main() {
 
 	conv := converter.NewConverter(
 		converter.WithPlugins(
+			base.NewBasePlugin(),
 			commonmark.NewCommonmarkPlugin(
 				commonmark.WithStrongDelimiter("__"),
 				// ...additional configurations for the plugin
@@ -90,7 +92,7 @@ func main() {
 - 🧑‍💻 [Example code, options](/examples/options/main.go)
 
 > [!NOTE]  
-> If you use `NewConverter` directly make sure to also **register the commonmark plugin**.
+> If you use `NewConverter` directly make sure to also **register the commonmark and base plugin**.
 
 ### Plugins
 

diff --git a/examples/options/main.go b/examples/options/main.go
@@ -5,6 +5,7 @@ import (
 	"log"
 
 	"github.com/JohannesKaufmann/html-to-markdown/v2/converter"
+	"github.com/JohannesKaufmann/html-to-markdown/v2/plugin/base"
 	"github.com/JohannesKaufmann/html-to-markdown/v2/plugin/commonmark"
 )
 
@@ -13,6 +14,7 @@ func main() {
 
 	conv := converter.NewConverter(
 		converter.WithPlugins(
+			base.NewBasePlugin(),
 			commonmark.NewCommonmarkPlugin(
 				commonmark.WithStrongDelimiter("__"),
 				// ...additional configurations for the plugin