diff --git a/README.md b/README.md index eb1ac96..92b0c31 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,25 @@ -# Simple Folder Filelist for Obsidian +# Simple Folder Filelist for Obsidian + +Generate a file in specified folders containing wiki-links to files in that folder. + ## Features -- Automatic filelist file generation -- Automatic linking of files in the folder +- Automatic filelist file generation +- Ribbon Icon to regenerate all filelists +- The filelist is a list of wiki-links - Reverse modification time listing (newest file first) - -### How to use +### Use - Install and enable the Plugin like any other. - In the **Settings** tab: - - Specify folders for which you want filelist files - - Specify the extensions of files to be omitted from these lists + - Specify “Included folder paths”: folders for which you want filelist files + - A folder path of “/“ generates an `ndx-root.md` file of the vault root directory + + + - Specify “Excluded extensions”: file extensions to exclude from folder filelists - - Adjust listfile pattern + - Adjust Listfile pattern: default pattern recommended - Exclude listfile from list: default and recommended setting is "On" -