obsidian-plugin/unarray_file-tree-generator
1
0
Fork 0
mirror of https://github.com/unarray/file-tree-generator.git synced 2026-07-22 08:40:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme

Browse source
This commit is contained in:
Unarray 2023-09-21 13:00:30 +02:00
parent c694ea17ef
commit 649239ef48
2 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -20,4 +20,13 @@ This patterns follow the [gitignore spec 2.22.1](https://git-scm.com/docs/gitign
![generate file tree pannel](meta/settings.png)
## Note
This plugin use FS *(desktop only)* to load files from your local directory.
This plugin use FS *(desktop only)* to load files from your local directory.
## Installation
In your vault folder, go to `./.obsidian/plugins/file-tree-generator/`
Then you can:
Clone this REPO and run `npm run build` or directly download latest plugin release containing `main.js`, `manifest.json` and `versions.json`.
> [!NOTE]
> If you are a developer, clone this repo -> run `npm i` -> start coding with `npm run dev` *(to hot-reload the plugin in obsidian, install [Hot-Reload plugin](https://github.com/pjeby/hot-reload))*

3
package.json
View file

@ -6,8 +6,7 @@
"main": "main.js",
"scripts": {
"dev": "tsup-node --watch ./src",
"build": "tsup-node",
"version": "node version-bump.mjs && git add manifest.json versions.json"
"build": "tsup-node"
},
"keywords": [
"file",