diff --git a/README.md b/README.md index 7226488..330a5ec 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,27 @@ # Obsidian File Explorer Notes Count +## Brief Explanation + - This plugin helps you to see the number of notes you have under all available folders within your file explorer. -- Collapsed Folders will show the total number of notes including all sub-folders. +- Counts will include total number of all markdown notes under a folder and its sub-folders. -- Uncollapsed folders won't have the number of notes in case they have sub-folders. +- By default, expanded folders won't have the number of notes in case they have sub-folders. -**Sample View** +## Sample View - \ No newline at end of file + + +## Settings + +- You can turn on the option for viewing the counts for all folders including the expanded folders. Otherwise, expanded folders won't have the number unless the expanded folder does not include any sub-folder. + + + +## Contact + +If you have any issue or you have any suggestion, please feel free to reach me out directly using contact page of my website [ozan.pl/contact/](https://www.ozan.pl/contact/) or directly to . + +## Support + +Buy Me A Coffee \ No newline at end of file diff --git a/images/collapsed-folder-setting.png b/images/collapsed-folder-setting.png new file mode 100644 index 0000000..bebeb78 Binary files /dev/null and b/images/collapsed-folder-setting.png differ diff --git a/images/folder-count.png b/images/folder-count.png index 480829a..375f588 100644 Binary files a/images/folder-count.png and b/images/folder-count.png differ