From 20ad9e35e180978ddf2fb8a4076849c635488cb2 Mon Sep 17 00:00:00 2001 From: Matt Greene <3sbwya@gmail.com> Date: Fri, 11 Aug 2023 11:52:45 -0400 Subject: [PATCH] Update documentation for MdUtils filename param --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e65a30b..1f41e0e 100644 --- a/README.md +++ b/README.md @@ -98,15 +98,18 @@ This is an example of a markdown file created using the mdutils python package. ## Create Markdown files -``create_md_file()`` is the last command that has to be called. +Using the `MdUtils` class, we can define a new Markdown object by specifying its filename and optionally it's title and author. The filename is used as the path for creating the the Markdown file. From here, Markdown syntax can be created using the provided methods in the `MdUtils` class (see below for examples). Finally, `create_md_file()` is called to create the file at the specified path. + ```python from mdutils.mdutils import MdUtils mdFile = MdUtils(file_name='Example_Markdown',title='Markdown File Example') +# Additional Markdown syntax... mdFile.create_md_file() ``` + ## Create Headers