commit ce824fd9d8dee7a0412e9e26dc286ceee2c3b96b
parent fb869e1abe543ba7fb8525972c7250bc7a85e485
Author: René Wagner <rwagner@rw-net.de>
Date: Sun, 27 Sep 2020 15:33:19 +0200
add config info in README
Diffstat:
1 file changed, 14 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ The devShort URL shortener is the perfect choice for web developers, admins and
### modifications compared to original devShort
* Short-URLs are case-insensitive, means "link" and "LINK" are the same redirect
-* Explore: show a random shortlink on index page
+* Explore section: show a random shortlink on index page
* fix for loosing counters
## 1-2-3 Reasons to install
@@ -28,7 +28,7 @@ The devShort URL shortener is the perfect choice for web developers, admins and
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
@@ -43,9 +43,20 @@ The passwort will be securely hashed at the first login on the admin page.
1. Download the latest [release](https://git.sr.ht/~rwa/devshort/refs) and upload it to the installation place
2. Start using devShort!
+## Configuration
+
+* `admin_password` -> password for the admin panel, is securely hashed after first login
+* `name` -> name of your site
+* `author` -> name of the author/admin
+* `home_link` -> link to your homepage
+* `favicon` -> relative path to your favicon, e.g. `assets/icon.png`
+* `random_shortlink` -> show "explore" section on index page, `true` or `false`
+* `custom_links` -> arbitrary amount of custom links that are shown on the right side of the footer
+
## About
-Maintainer: [flokX](https://github.com/flokX), Contributors: [René Wagner](https://sr.ht/~rwa)
+Maintainer: [René Wagner](https://sr.ht/~rwa)
+Creator: [flokX](https://github.com/flokX)
License: [The MIT License](https://git.sr.ht/~rwa/devshort/tree/master/LICENSE)
