Merge branch 'main' of https://github.com/LostPaul/obsidian-folder-notes

README.md

@@ -1,51 +1,11 @@
 # Obsidian folder notes
-Create notes within folders that can be accessed without collapsing the folder, similar to the functionality offered in Notion.
+Tldr: Create notes within folders that can be accessed without collapsing the folder, similar to the functionality offered in Notion.
 
-## Table of contents
-
-- [Features](#features)
-- [Credits](#credits)
-- [Showcase](#showcase)
-- [How to install the plugin](#how-to-install-the-plugin)
-
-## Features
-
-- Notes in folders
-- Click on folder name to open folder note
-- Folders don't collapse (can be changed in the settings)
-- Templater and templates support
-- The name of folders that contain folder notes are underlined (can get toggled in the settings)
-- Automatically create folder notes in folder on folder creation (can be turned on in the settings)
-- Exclude folders
-- Hide folder notes from file explorer
-#### Soon 
-- Create folder note for every existing folder
-
-## Showcase
-
-#### Open folder notes
-![wzk25GXUpc](https://user-images.githubusercontent.com/70213368/227169041-9bc7552e-c5f5-4001-94d9-b4c80ea88bd1.gif)
-
-#### Automatically create folder notes
-![Obsidian_NLUDzVBWRe](https://user-images.githubusercontent.com/70213368/227169603-3a105622-e6cb-4889-a709-acf52ad06d6e.gif)
-
-## How to install the plugin
-
-1. Download main.js, manifest.json, styles.css from the latest release (see [releases](https://github.com/LostPaul/obsidian-folder-notes/releases/))
-2. Create a new folder in `Vault-name/.obsidian/plugins` and put the downloaded files in there
-3. Reload your plugins and enable the plugin
-<img width="585" alt="Obsidian_QaY1e3nCzL" src="https://user-images.githubusercontent.com/70213368/227159411-5a2b0a99-f612-42f2-bc57-4f0a7f97d65e.png">
-<img width="582" alt="Obsidian_w4hTprcOjW" src="https://user-images.githubusercontent.com/70213368/227159064-e116ea0c-c249-4750-9b0f-b010e4a6afc5.png">
-
- 
-## Credits
-Thank you to everyone who has created a plugin that inspired me and I took code from.
-- Template suggester, created by [SilentVoid13](https://github.com/SilentVoid13) and [Liamcain](https://github.com/liamcain) (their plugins: [Templater](https://github.com/SilentVoid13/Templater/), [Periodic notes](https://github.com/liamcain/obsidian-periodic-notes))
-- Apply template to note, first seen in https://github.com/mgmeyers/obsidian-kanban/ from [Mgmeyers](https://github.com/mgmeyers)
-- Folder underline, inspired from https://github.com/aidenlx/alx-folder-note
-- Stop folders from collapsing, the basic idea from https://github.com/alangrainger/obsidian-folder-notes and some code lines
-- The basic idea is from https://github.com/xpgo/obsidian-folder-note-plugin
+Folder notes is a plugin for the note taking app  [Obsidian](https://obsidian.md/) that lets you attach notes to folders so that you can click on the name of a folder to open the note like in the app [Notion](https://www.notion.so/).
+This plugin has some unique features that separate it from similar "Folder note" plugins like opening folder notes through the path, creating folder notes for every existing folder, templater/template support and more.
 
+## Documentation & download link
+The plugin can be downloaded by clicking on https://obsidian.md/plugins?id=folder-notes and then on install. If you need help with the plugin or want to know what the features are that the plugin has then you can find the documentation at https://lostpaul.github.io/obsidian-folder-notes/. (it's currently at the beginning and will improve in the next days)
 
 ## Support the development of the plugin