Updated README.md

README.md

@@ -1,18 +1,50 @@
-# tiny0
+# How it works
 
-Custom URL shortener in Flask.
+Each URL that is submitted goes through a simple check for validity and/or added http:// before it to redirect successful.
-Definitely not yet finished.
+After that, a base 64 string is generated and added to a Sqlite database with the corresponding URL that was submitted.
-Please create issues or pull requestes for anything you may find.
+The user is then given a short URL that is formatted as: WEBSITE_DOMAIN/token, the token being the base 64 string.
+Whenever this URL is visited the user will get redirected to the tokens corresponding URL in the database.
 
-# To run
+# Run locally
 
-Would recommend to create a environment first
+**Highly encouraged to create a python environment first.**
+
+Clone the repository:
+
+	$ git clone https://github.com/xemeds/tiny0.git
+
+Move into the cloned folder and install the required libraries:
 
 	$ cd tiny0
 	$ pip install -r requirements.txt
+
+After that run with:
+
 	$ python run.py
 
-Then go to
+Visit the below URL to view the flask app:
+
 	127.0.0.1:5000
 
-NOTE: All redirects are currently local.
+**NOTE:** When running locally all redirects will also be local.
+
+# Deploying
+
+If you do not have a dedicated server, I highly recommend using [Heroku](https://devcenter.heroku.com/articles/getting-started-with-python), [PythonAnywhere](https://www.pythonanywhere.com/) or [AWS](https://aws.amazon.com/getting-started/projects/deploy-python-application/) to host your application.
+
+Before deploying set debug to False:
+
+	run.py -->> app.run(debug=True)
+
+And change the configurations:
+
+	tiny0 -->> config.json
+
+# License
+
+This project is under the [MIT](https://github.com/xemeds/tiny0/blob/master/LICENSE) license.
+
+# Donate
+
+**Bitcoin Address:** 1Mg55rPVuQ2P8zKsCcLdsmgqH24uLXfLbR
+