devshort

commit 2369e0a0c5d5be61282024a79da84000ebf74351
parent 49c462a763441c677de0b2b95c7dbf667dac0693
Author: René Wagner <rwa@noreply@clttr.info>
Date:   Mon,  3 Jan 2022 19:50:08 +0100

Update 'README.md'

Diffstat:
M
README.md
 | 
11
++++-------

1 file changed, 4 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
@@ -4,9 +4,7 @@ The devShort URL shortener is the perfect choice for web developers, admins and 
 
 ### Jump to our [demo](https://clttr.info)!
 
-
 ## 1-2-3 Main features
-
 1. Slim but powerful
     * No database required
     * Fast installation
@@ -24,27 +22,27 @@ The devShort URL shortener is the perfect choice for web developers, admins and 
 * fix for loosing counters
 
 ## 1-2-3 Reasons to install
-
 1. Give everyone a good-looking and easy to remember link
 2. Know when and how many times the links are used
 3. Have no hassle with the software because it's slim and easy to configure
 4. Absolutely no external deps, all that's required is shipped with the software.
 
 ## 1-2-3 Step installation
-
 1. Download the latest [release](https://src.clttr.info/rwa/devshort/releases) and upload it to the desired installation place
 2. Move `admin/config.json.example` to `admin/config.json` and `admin/stats.json.example` to `admin/stats.json`
 3. Adjust the configuration in `admin/config.json`, especially **insert a admin password**   
 The passwort will be securely hashed at the first login on the admin page.
 4. Start using devShort! 
 
-## 1-2-3 Step update
+### Requirements
+* Webserver (Apache, nginx, Caddy, ...)
+* PHP 7.4 or above
 
+## 1-2-3 Step update
 1. Download the latest [release](https://src.clttr.info/rwa/devshort/releases) and upload it to the installation place
 2. Start using devShort!
 
 ## Configuration
-
 All configuration is done in the file `data/config.json`. Below is a list of values that should be adjusted by the instance admin.
 
 * `admin_password` -> password for the admin panel, is securely hashed after first login
@@ -57,7 +55,6 @@ All configuration is done in the file `data/config.json`. Below is a list of val
 * `custom_links` -> arbitrary amount of custom links that are shown on the right side of the footer
 
 ## About
-
 * Maintainer: [René Wagner](https://src.clttr.info/rwa)
 * Creator: [flokX](https://github.com/flokX)