|
|
@@ -1,6 +1,9 @@
|
|
|
# OMI Project Branding plugin for Kanboard
|
|
|
|
|
|
-Project Branding plugin for Kanboard... TBA
|
|
|
+Project Branding plugin for Kanboard, to allow a custom logo and some brand colours per project.
|
|
|
+This is currently in progress. So far you can add a logo per project, and underline it with a custom colour .... yah!!!
|
|
|
+There is a lot of styles to build in yet and the header/title still needs fixing.
|
|
|
+I'm on it don't worry :)
|
|
|
|
|
|
## Author
|
|
|
* Dwayne Pivac @ OMI NZ
|
|
|
@@ -51,13 +54,25 @@ Download either zip file :
|
|
|
|
|
|
and uncompress/unzip/untar into your Kanboard `plugins` directory
|
|
|
|
|
|
-### Updating
|
|
|
+### Upgrading
|
|
|
+
|
|
|
+The best method is to use `git pull` if you installed via `git clone`.
|
|
|
+Otherwise the usual way is to use the Uninstall link in Kanboard, then copy the plugin directory into the 'plugins', directory.
|
|
|
+As your settings are kept in the database, you should back your database up before upgrading.
|
|
|
+Especially in the early versions where the database table will be modified.
|
|
|
+This message will change when the code is finalised :)
|
|
|
|
|
|
-TBA
|
|
|
|
|
|
## How to use
|
|
|
|
|
|
-TBA
|
|
|
+Use the "Branding" link in the left hand menu when you're in a project.
|
|
|
+You can modify the logo per project by entering an image URL ( no upload possible here ) into the 'Logo URL' field.
|
|
|
+The 'Accent Color' colour currently underlines the logo and that's all. It was just part of a PoC.
|
|
|
+Still WiP so check back later :)
|
|
|
+
|
|
|
+## Compatibility
|
|
|
+Compatibility with other Plugins.
|
|
|
+So far I know it works with Customizer, but it will override the global logo ( which is the point of this plugin ).
|
|
|
|
|
|
## Maintainers
|
|
|
|
