updated documentation

README.md

@@ -1,83 +1,73 @@
 <p align="center"><img src="https://www.giandonatoinverso.it/documentation/assets/DynamicQRCode_Original.png"></p>
-<b>PHP Dynamic Qr code </b> is a script that allows the generation and saving of dynamic and static QR codes. It has clean, responsive and user-friendly design. It is Based on <a href="https://adminlte.io/" target="_blank">AdminLte </a> the <i>"Best open source admin dashboard &amp; control panel theme. Built on top of Bootstrap" </i> and <a href="https://github.com/chetans9/core-php-admin-panel" target="_blank">Core PHP Admin Panel,</a> a simple Admin Pannel written in core PHP that contains an implementation of general features you might need in your website admin panel like: record management (CRUD), secure authentication, pagination, filters.<br><br>
 
-<p style="font-size: 200px"><a href="https://giandonatoinverso.it/qrcode" target="_blank">LIVE DEMO</a></p>
+**PHP Dynamic Qr code** is a script that allows the generation and saving of dynamic and static QR codes. It has a clean, responsive, and user-friendly design. It is based on [AdminLte](https://adminlte.io/), the "Best open source admin dashboard & control panel theme. Built on top of Bootstrap" and [Core PHP Admin Panel](https://github.com/chetans9/core-php-admin-panel), a simple Admin Panel written in core PHP that contains an implementation of general features you might need in your website admin panel like: record management (CRUD), secure authentication, pagination, filters.
-<p style="font-size: 200px"><a href="https://giandonatoinverso.it/documentation" target="_blank">DOCUMENTATION</a></p>
+
+[LIVE DEMO](https://giandonatoinverso.it/qrcode)
+
+[DOCUMENTATION](https://giandonatoinverso.it/documentation)
 
 [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=UEYVHYZYCGYYN)
 
-<h1>Features</h1>
+# Features
 
-<ul>
+- **#1 Dynamic Qr code generator on GitHub with a database to store Qr codes**
-<li><strong>#1 Dynamic Qr code generator on GitHub with database to store Qr codes</strong></li>
+- Create unlimited Qr codes
-<li>Create unlimited Qr code</li>
+- Easy installation wizard
-<li>Easy installation wizard</li>
+- Docker compose support
-<li>Control panel with 2 access levels and multi-user support</li>
+- Control panel with 2 access levels
-<li>Dashboard with advanced statistics on Qr code created and on scans</li>
+- Multi-account 
-<li>Dynamic Qr code</li>
+- Dashboard with advanced statistics on Qr codes created and on scans
-<ul>
+- Dynamic Qr code
-<li>Create, modify and delete Qr codes</li>
+    - Create, modify, and delete Qr codes
-<li>You can download yours Qr codes when you want</li>
+    - You can download your Qr codes when you want
-<li>URL shortener with redirect</li>
+    - URL shortener with redirect
-<li>Enable or disable the link redirect</li>
+    - Enable or disable the link redirect
-</ul>
+- Static Qr code
-<li>Static Qr code</li>
+    - Text QR Code
-<ul>
+    - Email QR Code
-<li>Text QR Code</li>
+    - Phone QR Code
-<li>Email QR Code</li>
+    - Sms QR Code
-<li>Phone QR Code</li>
+    - Whatsapp QR Code
-<li>Sms QR Code</li>
+    - Skype QR Code
-<li>Whatsapp QR Code</li>
+    - Location QR Code
-<li>Skype QR Code</li>
+    - Vcard QR Code
-<li>Location QR Code</li>
+    - Event/calendar QR Code
-<li>Vcard QR Code</li>
+    - Bookmark QR Code
-<li>Event/calendar QR Code</li>
+    - Wifi QR Code
-<li>Bookmark QR Code</li>
+    - Paypal QR Code
-<li>Wifi QR Code</li>
+    - Bitcoin QR Code
-<li>Paypal QR Code</li>
+- Customization of Qr codes
-<li>Bitcoin QR Code</li>
+    - 6 formats for images
-</ul>
+    - Foreground color
-<li>Customization of Qr codes</li>
+    - Background color
-<ul>
+    - 4 levels of precision
-<li>6 formats for images</li>
+    - 10 sizes
-<li>Foreground color</li>
+- Responsive bootstrap-based design
-<li>Background color</li>
+- Easy to understand and expand code
-<li>4 level of precision</li>
+- Full OOP with classes and well-documented
-<li>10 sizes</li>
+- Supported php version <= 8.1
-</ul>
+
-<li>Responsive bootstrap-based design</li>
+## What is included
-<li>Easy to understand and expand code</li>
+
-<li>Full OOP with classes and well documented</li>
+- PHP files
-<li>Supported php version <= 8.1</li>
+- .sql file with sample data
-</ul>
+- JS files
-<h2>What is included</h2>
+- CSS files
-<ul>
+- Docker compose file
-<li>PHP files</li>
+
-<li>.sql file with sample data</li>
+## Changelog
-<li>JS files</li>
+
-<li>CSS files</li>
+- Version 1.0 – September, 2020 (Initial release)
-<li>detailed code documentation</li>
+- Version 2.0 – 15th October, 2023
-</ul>
+    - Elimination of superfluous files
-<h2>Updates</h2>
+    - Moving read.php file within the project
-<ul>
+    - Addition of Qrcode class abstraction
-<li>Version 1.0 – September, 2020 (Initial release)</li>
+    - Improvement of bulk download
-<li>Version 2.0 – 15th October, 2023</li>
+    - General refactoring
-<ul>
+- Version 2.1 – 16th October, 2023
-<li>Elimination of superfluous files</li>
+    - Refactoring database tables
-<li>Moving read.php file within the project</li>
+    - Added script for upgrading to versions >= 2.0
-<li>Addition of Qrcode class abstraction</li>
+    - NEW: added multi-user support for dynamic/static qrcodes
-<li>Improvement of bulk download</li>
+- Version 2.2 – 16th October, 2023
-<li>General refactoring</li>
+    - Refactoring docker image building
-</ul>
+    - NEW: added docker-compose support
-<li>Version 2.1 – 16th October, 2023</li>
-<ul>
-<li>Refactoring database tables</li>
-<li>Added script for upgrading to versions >= 2.0</li>
-<li>NEW: added multi-user support for dynamic/static qrcodes</li>
-</ul>
-<li>Version 2.2 – 16th October, 2023</li>
-<ul>
-<li>Refactoring docker image building</li>
-<li>NEW: added docker compose support</li>
-</ul>
-</ul>