diff --git a/README.md b/README.md index 3ceef6d..78bad8c 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ -# File Tree Generator \ No newline at end of file +# File Tree Generator + +An Obsidian plugin allow you to generate file trees using [Obsidian Callouts](https://help.obsidian.md/Editing+and+formatting/Callouts)! + +## How to use? +When editing an Obsidian note, you can use `generate file tree` command or use the generate file tree Ribbon Icon.
+*(if you are on desktop, you can import a folder by pressing the extra button next to your files paths input)* + +![generate file tree pannel](meta/pannel.png) + +As you see, you can ignore patterns of files/folders in the setting tabs.
+This patterns follow the [gitignore spec 2.22.1](https://git-scm.com/docs/gitignore/2.22.1) + +![generate file tree pannel](meta/settings.png) + +## Note +This plugin use FS *(desktop only)* to load files from your local directory. \ No newline at end of file diff --git a/meta/pannel.png b/meta/pannel.png new file mode 100644 index 0000000..d8bce76 Binary files /dev/null and b/meta/pannel.png differ diff --git a/meta/settings.png b/meta/settings.png new file mode 100644 index 0000000..a3fe308 Binary files /dev/null and b/meta/settings.png differ