From 1e243bd3c0fbbc5fca1e592398e1cc23332a5cb4 Mon Sep 17 00:00:00 2001
From: Kasper Seweryn <github@wvffle.net>
Date: Wed, 20 Sep 2023 00:05:50 +0200
Subject: [PATCH] feat: add readme

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6822933
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Factorio <-> Telegram Bridge
+
+This bridge uses RCON to forward messages from Telegram to Factorio and Factorio's console log file to forward messages from Factorio to Telegram
+
+## Usage
+To use the program, you need to set some required options/environment variables:
+```
+Option                        Env var                 Description
+-t, --telegram-token          TELEGRAM_TOKEN          Telegram bot token
+-c, --telegram-chat-id        TELEGRAM_CHAT_ID        Telegram chat id
+-h, --factorio-rcon-host      FACTORIO_RCON_HOST      Factorio RCON host
+-p, --factorio-rcon-password  FACTORIO_RCON_PASSWORD  Factorio RCON password
+-l, --factorio-log-file       FACTORIO_LOG_FILE       Factorio console log file
+```
+
+### Factorio Friday Facts 
+
+When `--fff file_path` option is set, the bridge will check for new FFFs and send them to both chats. The file contains the latest title of the Factorio Friday Facts post in order to send the info about the FFF only once. 
+
+```
+Option  Env var     Description
+--fff   FFF         Factorio Friday Facts Cache File. If set, the bridge will check for new FFFs and send them to the chat [env: FFF=]
+```