summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitmodules2
-rw-r--r--README.md11
2 files changed, 12 insertions, 1 deletions
diff --git a/.gitmodules b/.gitmodules
index ec75f6f..136e707 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,3 +1,3 @@
[submodule "pythonFortniteStatus"]
path = pythonFortniteStatus
- url = git@snoopdesigns.site:/usr/local/git/python-fortnite-status.git
+ url = https://git.snoopdesigns.site/python-fortnite-status.git
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..57761c5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# Telegram bot with advanced Fortnite integration features
+
+## Running
+
+Build and execute using python environment:
+
+```
+TELEBOT_BOT_TOKEN=<bot token> python tgbot.py
+```
+
+On first run you wil be asked for a Fortnite API token, which can be obtained by accessing [this URL](https://www.epicgames.com/id/api/redirect?clientId=3446cd72694c4a4485d81b77adbb2141&responseType=code). Note: you need to be logged to Epic Games account in browser used to access token.