From a4de2dc86a5f52dfa775061f31a5f0d154de9b47 Mon Sep 17 00:00:00 2001
From: NotJohnnyTamale <81783950+ABUCKY0@users.noreply.github.com>
Date: Tue, 2 Apr 2024 13:40:01 -0500
Subject: [PATCH] Update and rename README to README.md

---
 README    |  1 -
 README.md | 22 ++++++++++++++++++++++
 2 files changed, 22 insertions(+), 1 deletion(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index a48ca75..0000000
--- a/README
+++ /dev/null
@@ -1 +0,0 @@
-This repository is not designed to be used outside of HelioHost, but if you wish to modify it to use for your own purposes, don't expect major support
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..95e600d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+### This repository is not designed to be used outside of HelioHost, but if you wish to modify it to use for your own purposes, don't expect major support
+
+# HelioNews Bot
+
+Designed as a replacement for HelioHost's older News bot, HelioNews uploads latest post from an RSS Feed.
+
+## Supported Platforms
+- 📷 Instagram
+- 👾 Facebook
+- 💬 Discord
+- 🐤 Twitter
+
+## Project Notes
+
+1. I had to develop an instagram posting bot *without* an Instagram account since I don't want to have a ton of social media accounts.
+2. HelioHost's RSS Feed doesn't have ETags, meaning I had to develop a way to check the last post using another method  
+  a. (I did this using the post's time btw)
+3. I take no credit in the background image that the image generation uses. (I Forgot what their name was replace this text later when you have a chance) created the background image and helped find the fonts used. They also suggested that I generate multiple images for the instagram post, which took a bit of testing to get right.
+4. I had to replace HTML tags with their real text counterparts, which was fun to make.
+
+## Contributing
+While this project is still being worked on, it is being actively used in production for HelioHost. This means that all pull requests must be verified working, and must be as minimally intrusive as possible (Ignore the large PR that is this refactoring).