diff --git a/README.adoc b/README.adoc index c453e797..4788b9a4 100644 --- a/README.adoc +++ b/README.adoc @@ -58,21 +58,21 @@ Libasciidoc provides 2 functions to convert an Asciidoc content into HTML: 1. Converting an `io.Reader` into an HTML document: - func ConvertToHTML(ctx context.Context, source io.Reader, output io.Writer, options renderer.Option...) (map[string]interface{}, error) + ConvertToHTML(r io.Reader, output io.Writer, config configuration.Configuration) (types.Metadata, error) 2. Converting a file (given its name) into an HTML document: - func ConvertFileToHTML(ctx context.Context, filename string, output io.Writer, options renderer.Option...) (map[string]interface{}, error) + ConvertFileToHTML(output io.Writer, config configuration.Configuration) (types.Metadata, error) -where the returned `map[string]interface{}` object contains the document's title which is not part of the generated HTML `` part, as well as the other attributes of the source document. +where the returned `types.Metadata` object contains the document's title which is not part of the generated HTML `` part, as well as the other attributes of the source document. -For now, the sole option to pass as a last argument is `renderer.IncludeHeaderFooter` to include the `
` and `