Skip to content

Commit

Permalink
Create INSTALL.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aljawaid committed Apr 29, 2023
1 parent 03a7654 commit 4eee3f1
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Plugin Installation

- **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 "A Kanboard plugin") installed:_
- Kanboard: `Settings` ⥂ `Plugins` ⥂ `Plugin Directory`
- **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
- **Install via [GitHub](https://github.com/ "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._

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

---

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

0 comments on commit 4eee3f1

Please sign in to comment.