From 4afec5ae5601954a5e77535cf8d568a5d3e4a14e Mon Sep 17 00:00:00 2001 From: Yuriy Date: Sat, 28 Jan 2023 00:31:29 -0500 Subject: [PATCH] Expanded readme --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index f9c0739..7d81948 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,24 @@ Automated posting to the following social media platforms, utilizing either the 4. Download the latest .exe of the Poster: https://git.zinchuk.xyz/yuriy/Freedomain-Social-Media-Poster/releases - When run, the poster will automatically create the folders and files it requires in the directory it's run from. +# Settings.ini +Freedomain Social Media Poster reads & saves data from a `settings.ini` file located in the same directory the the Poster. All customization, including custom profile URLs are stored here. The required fields are as follows: + +```` +[SocialMediaPoster] +LocalsURL=Your Locals Community Page URL +SubscribeStarProfileURL=Your Subscribestar Profile URL +DiscordParlerWebhookURL=Public Posts Webhook URL +DiscordErrorLoggingWebhookBotURL=Webhook URL Where Error & Status Messages get posted to +TelegramBotToken=Public Posts Bot Token +TelegramBotChatID=Public Posts Bot Chat ID +```` +- https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks +- https://tutorial.cytron.io/2021/09/01/how-to-create-a-telegram-bot-get-the-api-key-and-chat-id/ + +- All other settings will automatically get written to the `settings.ini` file as you check/uncheck the setting boxes while running the Poster. + + # Uncaught Script Errors I’ve done my best to catch any possible errors that might pop up and write functionality to handle them. But If an error happens that i haven't written resolves for, it will pop up a message box that looks like this. Please send me a screenshot so I can write a patch for the bug.