Merge pull request #11 from zeroquinc:chore--add-readme

chore: add readme

README.md

@@ -0,0 +1,58 @@
+# Steamcord
+A Discord bot for Steam embedded notifications.
+
+- Shows the name of the achievement
+- The details of the achievement
+- The global percentage unlock rate of the achievement across Steam
+- Unlock date and time of the achievement
+- Your overall progress across that game
+
+## Examples
+
+<table>
+  <tr>
+    <td>
+      <img src="https://github.com/zeroquinc/Steamcord/assets/39315068/663a3e7d-fc77-46b6-bcda-b2857a1c34e3" alt="image1">
+    </td>
+    <td>
+      <img src="https://github.com/zeroquinc/Steamcord/assets/39315068/03f05f3e-c136-434c-b8e7-40887382c47e" alt="image2">
+    </td>
+  </tr>
+</table>
+
+## How to use
+
+- Rename env to .env and fill in the variables
+- Pip install `requirements.txt`
+- Run `main.py`
+
+Your Steam ID can be found [here](https://www.steamidfinder.com/) and instructions on your API key can be found below
+
+## Getting your Steam API Key
+
+To get your Steam API Key, follow these steps:
+
+1. Go to the Steam API Key page at `https://steamcommunity.com/dev/apikey`.
+2. If you're not already logged in, you'll be asked to log in with your Steam account.
+3. Once logged in, you'll be asked to enter a domain name. This can be any valid domain name that you own, or a placeholder if you're just using the key for personal use.
+4. After entering a domain name, click on "Register".
+5. You'll be presented with your new API Key.
+
+Make sure to keep this key safe, as it gives access to Steam's APIs with your account.
+
+## Getting a Discord Bot
+
+To create a Discord bot, follow these steps:
+
+1. Go to the Discord Developer Portal at `https://discord.com/developers/applications`.
+2. Click on the "New Application" button.
+3. Give your application a name and click "Create".
+4. On the left-hand side, click on "Bot".
+5. Click on the "Add Bot" button on the right.
+6. You'll now have created a new bot. Under the bot's username, you'll see a section called "Token". Click on "Copy" to copy your bot's token. This is what you'll use to log in to the bot and control it.
+7. To add the bot to a server, go to the "OAuth2" section on the left-hand side.
+8. Under "Scopes", select "bot".
+9. Under "Bot Permissions", select the permissions your bot needs.
+10. Copy the generated URL and open it in your web browser to add the bot to a server you have manage permissions on.
+
+Remember to keep your bot's token safe, as anyone with the token can control your bot.

config/env

@@ -1,4 +1,6 @@
 # Discord Configuration
+# The Discord server ID is the ID of the server where the bot will post the achievements.
+# The Discord token is the token of the bot that will post the achievements.
 DISCORD_SERVER_ID =
 DISCORD_TOKEN =
 
@@ -18,5 +20,7 @@ STEAM_API_KEY ="API_KEY1,APIKEY2"
 STEAM_ID = "USER1,USER2"
 
 # Tasks
+# The achievement time is the time in seconds that the bot will wait before checking for new achievements.
+# The achievement channel is the channel ID where the bot will post the achievements.
 ACHIEVEMENT_TIME =
 ACHIEVEMENT_CHANNEL =