FIX: Content Flow for README.md

README.md

@@ -1,21 +1,18 @@
 # URLCleaner
-
-#### _Plugin for [Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software")_
+![GitHub All Releases](https://img.shields.io/github/downloads/aljawaid/URLCleaner/total?style=for-the-badge "GitHub All Downloads") - **_A plugin for [Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software")_**
 
 This simple tool extends the existing rewriting of browser URLs for your Kanboard application using this plugin. [URL Rewriting](https://docs.kanboard.org/v1/admin/url-rewriting/) must be correctly configured for this plugin to function properly.
 
 
-Features
--------------
+## Features
 
 - Extend core routes into clean URLs around the site
 - Extend selected plugin routes into clean URLs
   - Plugin Compatibility:
   - [Bigboard](https://github.com/TimoStahl/kanboard_plugin_bigboard), [Wiki](https://github.com/funktechno/kanboard-plugin-wiki), [Calendar](https://github.com/kanboard/plugin-calendar), [MetaMagik](https://github.com/creecros/MetaMagik)
 
 
-Screenshots
-----------
+## Screenshots
 
 **URL Management**  
 
@@ -24,72 +21,46 @@ Screenshots
 ![URL Management](../master/screenshot-url-cleaner-plugins.png)
 
 
-Usage
--------------
+## Usage
 
 Go to `Settings` ⥂ URL Cleaner
 
 
-Compatibility
--------------
-
-- Requires [Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software") ≥`1.2.20`
-
-#### Other Plugins & Action Plugins
-- Compatible with [CostControl](https://github.com/aljawaid/CostControl)
-#### Core Files & Templates
-- _No template overrides_
-- _No database changes_
-
-
-Changelog
----------
-
-Read the full [**Changelog**](../master/changelog.md "See changes")
-
-
-Installation
-------------
+## Installation & Compatibility
 
-- **Install via the [Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software") Plugin Directory**
-  - _Go to:_
-    - Kanboard: `Plugins` ⥂ `Plugin Directory`
-  - _or with [PluginManager](https://github.com/aljawaid/PluginManager) installed:_
-    - Kanboard: `Settings` ⥂ `Plugins` ⥂ `Plugin Directory`
+<details>
+    <summary><strong>Installation</strong></summary>
 
-**_or_**
+- Install via the **[Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software") Plugin Directory** or see [INSTALL.md](../master/INSTALL.md)
+- Read the full [**Changelog**](../master/changelog.md "See changes") to see the latest updates
 
-- **Install via the [Releases](../master/Releases/ "A copy of each release is saved in the folder") folder**
-  - A copy of each release is saved in the `/Releases` folder of the repository
-  - Simply extract the `.zip` file into the `/plugins` directory
+</details>
+<details>
+    <summary><strong>Compatibility</strong></summary>
 
-**_or_**
-
-- **Install via [GitHub](https://github.com/aljawaid "Find the correct plugin from the list of repositories")**
-  - Download the `.zip` file and decompress everything under the directory `/plugins`
-  - The folder inside the `.zip` must not contain any branch names and must be exact case (matching the plugin name)
-
-_Note: The `/plugins` folder is case-sensitive._
-
-**_or_**
+- Requires [Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software") ≥`1.2.20`
+- **Other Plugins & Action Plugins**
+  - _No known issues_
+  - Compatible with [CostControl](https://github.com/aljawaid/CostControl)
+- **Core Files & Templates**
+  - _No template overrides_
+  - _No database changes_
 
-- **Install using Git CLI**
-  - `git clone` (_or ftp upload_) and extract the `.zip` file into this folder: `.\plugins\` (must be exact case)
+</details>
+<details>
+    <summary><strong>Translations</strong></summary>
 
+- _Starter template available_
 
-Translations
-------------
+</details>
 
-- _Contributors welcome_
-- _Starter template available_
 
-Authors & Contributors
-----------------------
+## Authors & Contributors
 
 - [@aljawaid](https://github.com/aljawaid) - Author
 - _Contributors welcome_
 
 
-License
--------
+## License
+
 - This project is distributed under the [MIT License](../master/LICENSE "Read The MIT license")

changelog.md

@@ -34,5 +34,6 @@ _(most recent changes are listed on top):_
 - Initial release
 - Translations starter template included
 
+---
 
 Read the full [**Changelog**](../master/changelog.md "See changes") or view the [**README**](../master/README.md "View README")