diff --git a/README.md b/README.md index bbdb6515dde711054b02343dbc2956f291be5dd3..5c0226f6931f4e4b496a67468747757b5a1bb1ce 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # URL shorter +### For Instructions, please checkout the [wiki](https://gitlab.jonasled.de/jonasled/url_shorter_docker/-/wikis/home) -#### About +## About This is a URL shorter written in Python with Flask als Webhandler. The Webserver I used is Waitress and for the Database I used sqlite, because it's compact and works in this enviorement also with big databases (>2million entries) very quick. I started develloping this URL schorter, because google stopped their own and I can't find a very good one. Every shorter at the time on the market was boring or needed an account. For the first Version I used PHP, but the problem was, I packed everything in one very big file which was very hard to understand. At the time I wanted to use more than one domain I realized it is very hard to implement this, so I started searching for a better solution. The i found Flask, ehich is perfect, because you can split the Website code and the backend into multiple Files. So have fun to use this and contribute to it. -#### Features +## Features * Custom Links (user can select the short link himself) * multiple domains * protected with recaptcha @@ -14,7 +15,7 @@ This is a URL shorter written in Python with Flask als Webhandler. The Webserver * easy deployment * can run in offline enviorements (behind a firewall) -#### Why is this one better than other +## Why is this one better than other * no ADs * free to use * custom urls