From 21c90e52923b80af5b32cc55161bf6d8882000e1 Mon Sep 17 00:00:00 2001
From: Krzysiek Janiczek <26855867+ookris@users.noreply.github.com>
Date: Thu, 25 Apr 2024 18:02:07 +0200
Subject: [PATCH] Update README.md

---
 README.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 44f40de..2ea48f4 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,14 @@
-# QUrl Theme for [YOURLS](https://yourls.org)
-Theme for YOURLS
+# QUrl Theme for YOURLS
+A simple theme for [YOURLS](https://yourls.org) built based on the [Bootstrap](https://getbootstrap.com) framework.
+
+## Requirements
+Theme requires:
+* YOURLS itself, of course
+* plugin [U-SRV](https://github.com/joshp23/YOURLS-U-SRV)
+* plugin [YOURLS-IQRCodes](https://github.com/joshp23/YOURLS-IQRCodes)
+
+The [PHPMailer](https://github.com/PHPMailer/PHPMailer) library was used to send e-mail messages. Messages are sent via SMTP
+
+## Configuration
+The theme has basic configuration options. All options are located in the `qurl/config.php` file.
+The theme can be translated into other languages. To do this, you need to create your own language file based on the file `PL-pl_qurl.php`, which is located in the `qurl/lang` directory.
\ No newline at end of file