From c41b0a355c3a8c604b5fb8f2c76301720b563a31 Mon Sep 17 00:00:00 2001
From: Amit Serper <aserper@gmail.com>
Date: Mon, 4 Dec 2023 21:11:43 -0500
Subject: [PATCH] Readme

---
 README.md | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e47996b..3d8fa74 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,16 @@
-# masto-rss
+
+# Masto-rss
+
+A simple Mastodon bot written in python that posts updates from an RSS feed to a Mastodon account.
+
+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 >