diff --git a/README.md b/README.md index 256fcb3..42493ea 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,16 @@ + + # Masto-rss + + A simple Mastodon bot written in python that posts updates from an RSS feed to a Mastodon account. -Updates from the RSS feeds that were already posted will be saved to "processed_entries.txt" to prevent double posting. - This project is meant to be built to a docker container, so all of the options need to be set as environment variables: - -MASTODON_CLIENT_ID = Mastodon client ID - -MASTODON_CLIENT_SECRET = Mastodon client secret - -MASTODON_ACCESS_TOKEN = Mastodon access token - -MASTODON_INSTANCE_URL = Mastodon instance URL - -RSS_FEED_URL = URL of RSS/xml feed - -CHECK_INTERVAL = Time in seconds to refresh RSS feed - +MASTODON_CLIENT_ID = +MASTODON_ACCESS_TOKEN = +MASTODON_INSTANCE_URL = +RSS_FEED_URL = +The best way to use this project is by using [its docker container](https://hub.docker.com/r/amitserper/masto-rss) ![image](https://github.com/aserper/masto-rss/actions/workflows/masto-rss.yml/badge.svg) \ No newline at end of file