From 877251e9cfff765e8fb0c287615ea1ca60439430 Mon Sep 17 00:00:00 2001
From: NorbiPeti <norbipeti@norbipeti.eu>
Date: Fri, 11 Oct 2024 01:15:38 +0200
Subject: [PATCH] Hide actual config to avoid leaking the tokens

---
 .gitignore                         | 1 +
 README.md                          | 3 ++-
 config.yaml => config.example.yaml | 3 ++-
 3 files changed, 5 insertions(+), 2 deletions(-)
 create mode 100644 .gitignore
 rename config.yaml => config.example.yaml (93%)

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..5b6b072
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+config.yaml
diff --git a/README.md b/README.md
index 3840c7a..c553991 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,7 @@ It's also got solid foundations for Logging, Cogs, a YAML config, Mod Roles and
 
 ## Installation 
 - Obtain the code, fork via git, download, doesn't matter
-- Install requirements with `pip install requirements.txt`
+- Copy config.example.yaml to config.yaml
+- Install requirements with `pip install -r requirements.txt`
 - paste discord bot token in `config.yaml`
 - run with `python main.py`
diff --git a/config.yaml b/config.example.yaml
similarity index 93%
rename from config.yaml
rename to config.example.yaml
index a946592..99d57b9 100644
--- a/config.yaml
+++ b/config.example.yaml
@@ -1,6 +1,6 @@
 # Bot configuration
 prefix: "!"
-token: ""
+token: "Discord token"
 github_url: "https://git.norbipeti.eu/ExMods/RC2Bot"
 
 # A list of cogs to load at startup
@@ -11,6 +11,7 @@ cogs:
 
 # API configuration
 api_url: "https://norbipeti.eu/rc2matchmaking"
+api_token: "API token"
 # Add routes here. 
 routes:
   start_server: "/server/start"