From faeddafbb1cb6781549ac789adf338c97491dc6c Mon Sep 17 00:00:00 2001
From: Manuel Schneider <manuelschneid3r@gmail.com>
Date: Fri, 1 Mar 2024 11:47:24 +0100
Subject: [PATCH] [virtualbox:1.6] Add info on vboxapi requirement

---
 virtualbox/__init__.py | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/virtualbox/__init__.py b/virtualbox/__init__.py
index 4b628a2..3b90884 100644
--- a/virtualbox/__init__.py
+++ b/virtualbox/__init__.py
@@ -1,13 +1,18 @@
 # -*- coding: utf-8 -*-
 # Copyright (c) 2024 Manuel Schneider
+"""
+This plugin is based on [virtualbox-python](https://pypi.org/project/virtualbox/) and needs the 'vboxapi' module which
+is part of the VirtualBox SDK. Some distributions package the SDK, e.g. Arch has
+[virtualbox-sdk](https://archlinux.org/packages/extra/x86_64/virtualbox-sdk/).
+"""
 
 import virtualbox
 from virtualbox.library import LockType, MachineState
 
 from albert import *
 
-md_iid = '2.0'
-md_version = "1.5"
+md_iid = '2.2'
+md_version = "1.6"
 md_name = "VirtualBox"
 md_description = "Manage your VirtualBox machines"
 md_license = "MIT"
@@ -67,6 +72,17 @@ def __init__(self):
         PluginInstance.__init__(self, extensions=[self])
         self.iconUrls = ["xdg:virtualbox", ":unknown"]
 
+    def configWidget(self):
+        return [
+            {
+                'type': 'label',
+                'text': __doc__.strip(),
+                'widget_properties': {
+                    'textFormat': 'Qt::MarkdownText'
+                }
+            }
+        ]
+
     def handleTriggerQuery(self, query):
         items = []
         pattern = query.string.strip().lower()