From 9f94381272a3adc82f28d40dbbb34c6b4946453b Mon Sep 17 00:00:00 2001
From: NaiJi <naijiworld@protonmail.com>
Date: Sat, 16 Apr 2022 04:00:23 +0300
Subject: [PATCH] Add README.md

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e3af92f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# maid-bot
+
+Another bot for posting arts to your timeline. 
+
+Currently posting on: https://udongein.xyz/MaidBot
+
+### Initial setup
+
+* Create sources.dat file and fill them with URLs where
+```
+source_url_to_wget hyperlink_url_to_put_in_post_description
+source_url_to_wget hyperlink_url_to_put_in_post_description
+source_url_to_wget hyperlink_url_to_put_in_post_description
+source_url_to_wget hyperlink_url_to_put_in_post_description
+ . . . . . . . . . . etc
+```
+* Fill token.dat with bot's auth token.
+* Edit post-local.sh and write custom text. in "status" field of POST json.
+* Now put it to crontab!
+
+The bot will take random pair of URLs from the file, download the image itself by the first url and post it to fedi, attaching the second url as description.