chore: start of readme

.github/workflows/release-please.yml

@@ -2,23 +2,15 @@ on:
     push:
       branches:
         - main
-
 permissions:
     contents: write
     pull-requests: write
-
 name: release-please
-
 jobs:
     release-please:
       runs-on: ubuntu-latest
       steps:
         - uses: googleapis/release-please-action@v4
           with:
-            # this assumes that you have created a personal access token
-            # (PAT) and configured it as a GitHub action secret named
-            # `MY_RELEASE_PLEASE_TOKEN` (this secret name is not important).
             token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
-            # this is a built-in strategy in release-please, see "Action Inputs"
-            # for more options
             release-type: simple

README.md

@@ -1 +1,20 @@
-# torbox-tinfoil-server
+![Logo](https://raw.githubusercontent.com/TorBox-App/torbox-tinfoil-server/main/assets/header.png)
+
+
+#### About
+
+The TorBox Tinfoil Server allows you to easily set up your own custom Tinfoil shop of curated items downloaded from TorBox. This allows you to use TorBox as a repository rather than storing your files on your own server, or relying on someone else to download them for you. 
+
+#### Important Notice
+TorBox does not allow piracy or condone it in any way. This is meant to be used with games you own and have the rights to.
+
+
+## Environment Variables
+
+To run this project, you will need to add the following environment variables to your .env file
+
+`TORBOX_API_KEY`
+
+`AUTH_USERNAME`
+
+`AUTH_PASSWORD`