Wobbl/OMG
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Corrected the type of OMG.md_files in the README.md

Browse source
This commit is contained in:
The Wobbler 2025-04-10 11:41:21 +02:00
parent 8c827f40e7
commit 5521f73291
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -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)`.