Add documentation

README.md

@@ -0,0 +1,12 @@
+# ResultFeedback
+This module adds an enhanced feedback form that can be configured via config file.
+
+## Usage
+Integrate the module in the `modules` directory of VuFind and activate it by adding `ResultFeedback` to `VUFIND_LOCAL_MODULES`.  
+When adding the module manually make sure to copy and adapt the config file and copy/symlink the theme.
+
+Add the following line to your template to link to the feedback form:
+```php
+<a href="<?=$this->url('resultfeedback-email').'?id='.$this->driver->getUniqueId().'&searchclassid='.$this->searchClassId?>">Contact us about this title</a>
+```
+

config/vufind/resultFeedback.ini

@@ -0,0 +1,17 @@
+[resultFeedback]
+user_types[] = User type 1
+user_types[] = User type 2
+
+recipient_email    = "[email protected]"
+recipient_name     = "Example Host"
+email_subject      = "Mail from result feedback form"
+sender_email       = "[email protected]"
+sender_name        = "Example Host"
+
+set_user_email_as_reply_to = true
+set_user_email_as_cc = true
+
+base_url_Solr      = "https://example.com/vufind/Record/"
+base_url_Search2   = "https://example.com/vufind/Search2Record/"
+
+ip_local_network[] = 192.168.178