Skip to content

Commit

Permalink
Update and rename README to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ABUCKY0 authored Apr 2, 2024
1 parent a007261 commit a4de2dc
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
1 change: 0 additions & 1 deletion README

This file was deleted.

22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit a4de2dc

Please sign in to comment.