Add documentation

README.md

@@ -1,3 +1,7 @@
-Module to display icons of belugino instead of noCoverAvailableImage image.
+# BeluginoCover  
+This module displays icons for different media types of the belugino font instead of noCoverAvailableImage image.  
+See [beluga-core.de/belugino](https://www.beluga-core.de/belugino/) for available icons.
 
-See https://www.beluga-core.de/belugino/ for available icons.
+## Usage
+Integrate the module in the `modules` directory of VuFind and activate it by adding `BeluginoCover` to `VUFIND_LOCAL_MODULES`.  
+When adding the module manually make sure to copy and adapt the config file and copy/symlink the theme.  

src/BeluginoCover/View/Helper/BeluginoCover/BeluginoCover.php

@@ -1,6 +1,6 @@
 <?php
 /**
- *
+ * BeluginoCover helper
  */
 namespace BeluginoCover\View\Helper\BeluginoCover;
 
@@ -11,13 +11,18 @@ class BeluginoCover extends AbstractHelper
     protected $config;
 
     /**
-     *
+     * Constructor
      */
     public function __construct($config)
     {
         $this->config = $config;
     }
 
+    /**
+     * Get icon class for given media type
+     * @param $format media type
+     * @return mixed
+     */
     public function getIconClass($format) {
         return $this->config['belugino'][$format];
     }

src/BeluginoCover/View/Helper/BeluginoCover/BeluginoCoverFactory.php

@@ -31,7 +31,7 @@
 use Laminas\ServiceManager\Factory\FactoryInterface;
 
 /**
- * SearchBox helper factory.
+ * BeluginoCover helper factory.
  *
  * @category VuFind
  * @package  View_Helpers