|
|
@@ -1,3 +1,68 @@
|
|
|
-# OMIProjectBranding
|
|
|
+# OMI Project Branding plugin for Kanboard
|
|
|
+
|
|
|
+Project Branding plugin for Kanboard... TBA
|
|
|
+
|
|
|
+## Author
|
|
|
+* Dwayne Pivac @ OMI NZ
|
|
|
+* License MIT
|
|
|
+
|
|
|
+## Requirements
|
|
|
+
|
|
|
+* Kanboard 1.2
|
|
|
+* PHP 8.2.0
|
|
|
+
|
|
|
+It is possible this works with other versions of Kanboard and PHP, but these are the version this was built and tested on.
|
|
|
+
|
|
|
+## How to install this plugin
|
|
|
+
|
|
|
+All Kanboard plugins are found in the `plugins` directory. In general you just put your plugin there and that's about it!
|
|
|
+
|
|
|
+### CLI
|
|
|
+
|
|
|
+In a terminal window ( or command for Windoze ) browse/cd to your Kanboard `plugins` directory and issue this command
|
|
|
+
|
|
|
+#### git clone ( best method )
|
|
|
+
|
|
|
+`git clone https://vcs.nz/ominz/OMIProjectBranding.git`
|
|
|
+
|
|
|
+#### wget
|
|
|
+
|
|
|
+##### zip ( Windoze )
|
|
|
+
|
|
|
+`wget https://vcs.nz/ominz/OMIProjectBranding/archive/main.zip`
|
|
|
+
|
|
|
+`unzip main.zip`
|
|
|
+
|
|
|
+`del main.zip`
|
|
|
+
|
|
|
+##### tar ( Nix )
|
|
|
+
|
|
|
+`wget https://vcs.nz/ominz/OMIProjectBranding/archive/main.tar.gz`
|
|
|
+
|
|
|
+`tar -xzf main.tar.gz`
|
|
|
+
|
|
|
+`rm main.tar.gz`
|
|
|
+
|
|
|
+### GUI
|
|
|
+
|
|
|
+Download either zip file :
|
|
|
+* [https://vcs.nz/ominz/OMIProjectBranding/archive/main.zip](https://vcs.nz/ominz/OMIProjectBranding/archive/main.zip)
|
|
|
+* [https://vcs.nz/ominz/OMIProjectBranding/archive/main.tar.gz](https://vcs.nz/ominz/OMIProjectBranding/archive/main.tar.gz)
|
|
|
+
|
|
|
+and uncompress/unzip/untar into your Kanboard `plugins` directory
|
|
|
+
|
|
|
+### Updating
|
|
|
+
|
|
|
+TBA
|
|
|
+
|
|
|
+## How to use
|
|
|
+
|
|
|
+TBA
|
|
|
+
|
|
|
+## Maintainers
|
|
|
+
|
|
|
+* Dwayne <dwayne at omi dot nz>
|
|
|
+* OMI Ltd. <adm at omi dot nz>
|
|
|
+
|
|
|
+
|
|
|
|
|
|
-Project Branding plugin for Kanboard, to allow a custom logo and some brand colours per project.
|
