commit a7bbc7d0b1df1fee5f84448a2eb4ae2f21e5228e parent f74c8ea3a5bac1df988ab4593f31ce3467b6b878 Author: Florian <flokX@users.noreply.github.com> Date: Wed, 2 Jan 2019 16:49:17 +0100 Initial real README.md Diffstat:
| M | README.md | | | 39 | ++++++++++++++++++++++++++++++++++++++- |
1 file changed, 38 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md @@ -1,2 +1,39 @@ # devShort -A URL shortener for developers and professionals + +The devShort URL shortener is the perfect choice for web developers, admins and all professionals. + +What is a URL shortener? Visit our [wiki article](wiki/Installation) for more information. + + +## 1-2-3 Main features + +1. Slim but powerful + * No database required + * Fast installation + * Integrated statistics viewer +2. Widely configurably for your needs with one file only +3. Privacy friendly + * The whole code is verifiable in minutes + + +## 1-2-3 Reasons to install + +1. With devShort you will never again have problems regarding legal questions because we only track the number of requests the shortlinks gain. +2. It's quite easy to install, upgrade and maintain because there are only 16 files with a size of 1,04 MB only to upload. +3. The appearence of the public pages can be changed easily with the `config.json` file. + + +## 1-2-3 Click installation + +1. Copy the files into the directory +2. Insert a admin password in the `config.json` +3. Run the `installer.php` + +That's it! If you want to know what devShort can do visit our [wiki](wiki). + + +## License + +Maintainer: [flokX](https://github.com/flokX) + +License: The MIT license