diff --git a/README.md b/README.md index 36a212e..5649cf2 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,28 @@ -# Open Editors Obsidian Plugin > [!WARNING] > This Plugin is under Development! -This is a plugin for Obsidian (https://obsidian.md). +Adds a view which shows the opened windows, groups, tabs and editors inside them. Makes managing the open editors easier. +![image](https://github.com/user-attachments/assets/ac09bdb3-9914-4d91-9db0-ff898b7960d8) -Adds a view which shows the opened groups and the tabs inside them. Allow to close groups or all tabs at once. -Example: ![image](https://github.com/user-attachments/assets/61327915-5342-4dd2-b6ce-a99363b4f8dc) +# Features +- Close all ediors in window or group at once +- Switch to other editor + +# Planed Features +- Rearange your groups, windows or editors by drag and drop + +# Contribution +Feel free to contribute. + +You can create an [issue](https://github.com/4Source/open-editors-obsidian-plugin/issues) if you found a bug, have an idea to improve this plugin or ask a question. Please make sure beforehand that your issue does not already exist. + +Or instead create a [pull request](https://github.com/4Source/open-editors-obsidian-plugin/pulls) to contribute a bug fix or improvement for this plugin. + +*Not a developer* but still want to help? You can help with testing. Either you test the current version for possible problems or, if there are currently any, you can also test [pre-releases (alpha/beta)](https://github.com/4Source/open-editors-obsidian-plugin/releases). This can be easily accomplished if you install [VARE](https://obsidian.md/plugins?id=vare). Any version of this plugin must be installed. Then simply go to VARE's Settings tab and select the version you want to test from the drop-down menu. You could also add this plugin manually just ![plus](https://github.com/4Source/settings-profiles-obsidian-plugin/assets/38220764/663a0bd6-53f9-4da3-b0ab-33e30eae3029)``Add unlisted plugin`` and enter ``4Source`` and ``open-editors-obsidian-plugin``. If you found a bug or unexpected behavior create an [issue](https://github.com/4Source/open-editors-obsidian-plugin/issues) with the version you have tested. Before creating an issue, make sure you know how to reproduce the bug. If there is already an issue for the bug you found that is still open but you have additional information, add it to the issue. + +For more info see [CONTRIBUTING](https://github.com/4Source/open-editors-obsidian-plugin/blob/master/.github/CONTRIBUTING.md) + +# Support +If you want to support me and my work. + +[BuyMeACoffee](https://www.buymeacoffee.com/4Source)