diff --git a/README.md b/README.md index 6d2bc49..ad1c787 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # tiny0 + Custom URL shortener in Flask. +Definitely not yet finished. +Please create issues or pull requestes for anything you may find. + +# To run + +Would recommend to create a environment first + + $ cd tiny0 + $ pip install -r requirements.txt + $ python run.py + +Then go to + 127.0.0.1:5000 + +NOTE: All redirects are currently local.