diff --git a/README.md b/README.md index a7948f9..7db0999 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # tinyl-shortener -URL shortening web service developed with Flask +URL shortening / safety checker web service + +A basic URL shortener service which uses built-in modules and those which come with the Flask package. + +Performs validation checks against user input to prevent attacks such as SQL injection when dealing with database queries. + +Returns a unique path for each given URL which successfully redirects to given destination URL. + +Abuse preventative measures implemented which perform checks on given URL to ensure safety before redirection. + + +Another service included is the ability to perform safety checks on suspicious URLs - the supplied URL is checked against different blacklist providers which returns any providers +that have blacklisted the URL and for what reason. + +DNS queries are also made against the given URL/domain to gather information such as domain creation date, location, providers - combining the returned data allows me to provide users with a background of the given site and any potential security risks associated.