update setup documentation

Author: SharpBit

.env.example

@@ -1,9 +1,9 @@
 DISCORD_CLIENT_ID = # Oauth Client ID
 DISCORD_CLIENT_SECRET # Oauth client secret
-ENV = # Production or development
-REQUEST_TOKEN = # Authorization Token
-PORT = # port to host webserver own
-DB_USERNAME = # Postgresql Username
-DB_PASSWORD = # Postgresql Password
-DB_HOST = # Database host IP
-DB_NAME = # Database name
+ENV = # production or development
+REQUEST_TOKEN = # Brawl stars API Authorization Token
+PORT = # port to host the website own
+DB_USERNAME = # Postgres Username
+DB_PASSWORD = # Postgres Password
+DB_HOST = # Postgres database host IP
+DB_NAME = # Postgres database name

README.md

@@ -1,2 +1,21 @@
 # sharpbit.dev
-A python sanic [website](https://sharpbit.dev/) that I made
+A [website](https://sharpbit.dev/) made with Python and Sanic. It uses Bootstrap in the front-end.
+
+### Deployment
+#### Running without Docker
+1. Populate the `.env` file with the necessary information as outlined in `.env.example`.
+2. Install the requirements by running `pip install -r requirements.txt`.
+3. Run the server with `python run.py`. The server should be up and running at `localhost:PORT`.
+
+#### Deploy with Docker
+1. Populate the `.env` file with the necessary information as outlined in `.env.example`.
+2. Build and start the container in detached mode using `docker-compose up -d`.
+3. Optionally, check the docker container list using `docker ps`.
+
+#### Update with changes
+1. Update the local repo with `git pull`.
+2. Restart the container with `docker restart <container_id>`.
+3. Optionally, check the logs with `docker logs <container_id>`.
+
+#### Kill the server
+1. Run `docker kill <container_id>`.