diff --git a/README.md b/README.md index 1048f9f..cb93f13 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # Obsidian Advanced Merge -Merge a folder of notes for easier export. This plugin is designed for [obsidian](https://obsidian.md/) app. \ No newline at end of file +Merge a folder of notes for easier export. This plugin is designed for [obsidian](https://obsidian.md/) app. + +![preview](https://github.com/antoKeinanen/obsidian-advanced-merger/raw/master/media/2023-03-16%2018-23-14.gif) + +## Installation +Installation through obsidian plugin marketplace is not yet supported. But Advanced Merge can be downloaded manually. + +1. Download the latest release from [releases page](https://github.com/antoKeinanen/obsidian-advanced-merger/releases). +2. Extract the zip archive. +3. Move the 2 files (`manifest.json`, and `main.js`) to `/.obsidian/plugins/obsidian-advanced-merger` +4. Start obsidian, go to settings>community plugins, and turn `Advanced merger` on. + +## Usage +Using Advanced merge is very easy! Just right click a folder and select `merge folder`. + +## Support +You can support me by buying me a coffee at [buymeacoffee.com](https://www.buymeacoffee.com/antokeinanen)! \ No newline at end of file