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 e1462b5 commit b7233c0
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 57 deletions.
85 changes: 28 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
# KanboardEmailHistory

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

This plugin adds a new Automatic Action to provide any user or department to receive a final email report when a task is closed. Automatic emails are sent detailing the task description including the full comment history. Let this plugin create a digital file copy of your tasks using advanced options including emailing different recipients, adding comment logs and a fallback for a blank email subject line.


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

- Create unique subjects for different types of projects or tasks
- Works with Kanboard background jobs
Expand Down Expand Up @@ -35,8 +33,7 @@ Features
- `PROJECT NAME` + `PROJECT IDENTIFIER` + `TASK TITLE`


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

**Configure this project**

Expand Down Expand Up @@ -66,75 +63,49 @@ Screenshots

![Error Messages](../master/Screenshots/error-messages.png "Error Messages")

Usage
-------------

Go to `Project` ⥂ `Automatic Actions` ⥂ `EmailTaskHistory > Send task description and complete comment history on task closure` ⥂ _Enter parameter values for the action_


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

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

#### Other Plugins & Action Plugins
- Compatible with [AutomaticActionUX](https://github.com/aljawaid/AutomaticActionUX), [AutoSubtasks](https://github.com/creecros/AutoSubtasks), [ApplicationBranding](https://github.com/aljawaid/ApplicationBranding)
#### Core Files & Templates
- `01` Template override
- _No database changes_


Changelog
---------

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

Go to `Project` ⥂ `Automatic Actions` ⥂ `EmailTaskHistory > Send task description and complete comment history on task closure` ⥂ _Enter parameter values for the action_

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

**_or_**

- **Install via [GitHub](https://github.com/url "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)
## Installation & Compatibility

_Note: The `/plugins` folder is case-sensitive._
<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 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>Compatibility</strong></summary>

- Requires [Kanboard](https://github.com/kanboard/kanboard "Kanboard - Kanban Project Management Software")`1.2.20`
- **Other Plugins & Action Plugins**
- _No known issues_
- Compatible with [AutomaticActionUX](https://github.com/aljawaid/AutomaticActionUX), [AutoSubtasks](https://github.com/creecros/AutoSubtasks), [ApplicationBranding](https://github.com/aljawaid/ApplicationBranding)
- **Core Files & Templates**
- `01` Template override
- _No database changes_

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

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

</details>

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

## Authors & Contributors

- [@aljawaid](https://github.com/aljawaid) - Author
- [Craig Crosby](https://github.com/creecros) - Contributor
- _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 @@ -124,5 +124,6 @@ _(most recent changes are listed on top):_
- NEW: Added `en_GB` translations
- Rename EmailFullTaskHistory to EmailTaskHistory

---

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

0 comments on commit b7233c0

Please sign in to comment.