From 5521f7329159489042e05966de8f6baf13f84d85 Mon Sep 17 00:00:00 2001 From: The Wobbler Date: Thu, 10 Apr 2025 11:41:21 +0200 Subject: [PATCH] Corrected the type of OMG.md_files in the README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bbb17ce..87ab464 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ omg.py . ### Python API To use the script as a module, simply import it and create an instance of the OMG class with the `path`-parameter set -to your vault path. The metadata is stored as a dict in `instance.md_files`. +to your vault path. The metadata is stored as a list[dict] in `instance.md_files`. Example: @@ -46,7 +46,7 @@ Example: from omg import OMG metadata = OMG("/home/user/.obsidian/myVault") -as_dict = metadata.md_files +as_list = metadata.md_files ``` To write the metadata, you can use `instance.dump(path: Pathlike=None, indent=2)`.