Skip to content

Commit

Permalink
FIX: Content Flow for README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aljawaid committed Apr 29, 2023
1 parent 5baa6b7 commit 4d7576d
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 76 deletions.
103 changes: 27 additions & 76 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
# KanboardCSS
![GitHub All Releases](https://img.shields.io/github/downloads/aljawaid/KanboardCSS/total?style=for-the-badge "GitHub All Downloads")

#### _Theme Plugin for [Kanboard](https://github.com/fguillot/kanboard "Kanboard - Kanban Project Management Software")_
![GitHub All Releases](https://img.shields.io/github/downloads/aljawaid/KanboardCSS/total?style=for-the-badge "GitHub All Downloads") - **_A theme plugin for [Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software")_**

This pure CSS theme replaces the look and feel of the Kanboard user interface. For modern browsers using gradients and shades of blue and red, KanboardCSS refreshes the the user experience. A new animated notification icon easily identifies new messages without affecting browser performance. All tables and forms are restyled to save screen space and improve productivity. This theme works perfectly with other plugins.


Features
-------------
## Features

- Show current page indicator in dropdown menus
- Animated notification icon for new messages
Expand All @@ -16,8 +13,7 @@ Features
- The whole interface is refreshed for an improved user experience.


Screenshots
----------
## Screenshots

_Screenshots are for illustrative purposes only and may show features from other plugins._

Expand All @@ -28,86 +24,41 @@ _Screenshots are for illustrative purposes only and may show features from other
![Tasks](../master/Screenshots/screenshot-task.png)


Usage
-------------
## Usage

Refresh the page or restart your browser.

## Installation & Compatibility

Compatibility
-------------

- Requires [Kanboard](https://github.com/fguillot/kanboard "Kanboard - Kanban Project Management Software")`1.0.44`

#### Other Plugins & Action Plugins
- _No known issues_
- Compatible with [Customizer](https://github.com/creecros/Customizer "Customizer - A plugin for Kanboard"), [Bak2TopBotm](https://github.com/creecros/Bak2topbotm "Bak2TopBotm - A plugin for Kanboard"), [Glancer](https://github.com/aljawaid/Glancer "Glancer - A plugin for Kanboard"), [ColorManager](https://github.com/aljawaid/ColorManager "ColorManager - A plugin for Kanboard"), [ApplicationBranding](https://github.com/aljawaid/ApplicationBranding "ApplicationBranding - A plugin for Kanboard"), [TemplateManager](https://github.com/aljawaid/TemplateManager)

#### Core Files & Templates
- _No template overrides_
- _No database changes_


Changelog
---------

Read the full [**Changelog**](../master/changelog.md "See changes")


Installation
------------

- **Install via the [Kanboard](https://github.com/fguillot/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`

**_or_**

- **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>
<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 [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)
</details>
<details>
<summary><strong>Compatibility</strong></summary>

_Note: The `/plugins` folder is case-sensitive._
- Requires [Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software")`1.2.20`
- **Other Plugins & Action Plugins**
- _No known issues_
- Compatible with [Customizer](https://github.com/creecros/Customizer "Customizer - A plugin for Kanboard"), [Bak2TopBotm](https://github.com/creecros/Bak2topbotm "Bak2TopBotm - A plugin for Kanboard"), [Glancer](https://github.com/aljawaid/Glancer "Glancer - A plugin for Kanboard"), [ColorManager](https://github.com/aljawaid/ColorManager "ColorManager - A plugin for Kanboard"), [ApplicationBranding](https://github.com/aljawaid/ApplicationBranding "ApplicationBranding - A plugin for Kanboard"), [TemplateManager](https://github.com/aljawaid/TemplateManager)
- **Core Files & Templates**
- _No template overrides_
- _No database changes_

**_or_**

- **Install Manually via Settings**
- Copy content data from `kanboardcss.css`
- 1. Go to Kanboard: `Settings` &#10562; `Application Settings`
- 2. Paste into the `Custom Stylesheet` section
- 3. Save

_Note: Not fully compatible with MySQL-Kanboard environments due to the field limit_

**_or_**

- **Install via [Customizer](https://github.com/creecros/Customizer "Customizer - A plugin for Kanboard") plugin**
- Copy the file `kanboardcss.css` to the folder `/plugins/Customizer/Assets/css/themes/` if using the [Customizer](https://github.com/creecros/Customizer "Customizer - A plugin for Kanboard") plugin

**_or_**

- **Install using Git CLI**
- `git clone` (_or ftp upload_) and extract the `.zip` file into this folder: `.\plugins\` (must be exact case)


Translations
------------
</details>
<details>
<summary><strong>Translations</strong></summary>

- English (UK), English (US), French, German, Spanish
- _Contributors welcome_
- _Starter template available_

</details>

Authors & Contributors
----------------------

## Authors & Contributors

- [@aljawaid](https://github.com/aljawaid) - Author & Maintainer _(from v1)_
- [Thomas T. Jarløv](https://github.com/ThomasTJdev) - Original Author
Expand All @@ -119,6 +70,6 @@ Authors & Contributors
- _Contributors welcome_


License
-------
## License

- This project is distributed under the [MIT License](../master/LICENSE "Read The MIT license")
1 change: 1 addition & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,5 +184,6 @@ _(most recent changes are listed on top):_
_(most recent changes are listed on top):_
* Initial release

---

Read the full [**Changelog**](../master/changelog.md "See changes") or view the [**README**](../master/README.md "View README")

0 comments on commit 4d7576d

Please sign in to comment.