From 4762a8dff33643e2169e8f2e8c91ac66c7822c68 Mon Sep 17 00:00:00 2001
From: jwansek <eddie.atten.ea29@gmail.com>
Date: Sat, 27 Sep 2025 22:53:12 +0100
Subject: Updated README.md

---
 Dockerfile          |  1 +
 README.md           | 21 +++++++++++++++++++++
 config.json.example | 13 +++++++++++++
 crontab             |  2 --
 exampleconfig.json  | 13 -------------
 readme.md           | 33 ---------------------------------
 6 files changed, 35 insertions(+), 48 deletions(-)
 create mode 100755 README.md
 create mode 100755 config.json.example
 delete mode 100755 crontab
 delete mode 100755 exampleconfig.json
 delete mode 100755 readme.md

diff --git a/Dockerfile b/Dockerfile
index f6697f2..66c005e 100755
--- a/Dockerfile
+++ b/Dockerfile
@@ -1,4 +1,5 @@
 FROM reg.reaweb.uk/cron
+# https://github.com/jwansek/cron/
 ENV TZ=Europe/London
 RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
 RUN apt-get update -y
diff --git a/README.md b/README.md
new file mode 100755
index 0000000..7b84dfe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Yaoi Communism Twitter Bot
+
+Forked from the yuri version.
+
+Unlike the yuri version, we don't have an archive of images and sources
+to use. Instead, download yaoi images on the fly from safebooru.org.
+Designed to be run once an hour using a cron job.
+
+## Running in docker
+
+- `sudo docker compose build`
+
+- `sudo docker compose up -d`
+
+Should do everything by itself if you set the config file correctly
+
+To manually run (for testing):
+
+`sudo docker run -it --entrypoint python3 --rm reg.reaweb.uk/yaoi-communism /app/bot.py`
+
+![Example image](https://pbs.twimg.com/media/EgSA-hVXoAIXLbB?format=jpg&name=large)
diff --git a/config.json.example b/config.json.example
new file mode 100755
index 0000000..31418ce
--- /dev/null
+++ b/config.json.example
@@ -0,0 +1,13 @@
+{
+    "logpath": "yc.log",
+    "blacklist": "posted_images.csv",
+    "texts": "texts/quotes.txt",
+    "base_tags": ["yaoi", "-muscle", "-comic", "-text"],
+    "search_tags": ["looking_at_another", "kiss", "trap", "2boys", "promare"],
+    "twitterapi":{
+        "consumer_key": "xxxxxxxxxxxxxxxxxxx",
+        "consumer_secret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
+        "access_token": "xxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxx",
+        "access_token_secret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
+    }
+}
\ No newline at end of file
diff --git a/crontab b/crontab
deleted file mode 100755
index 3b74066..0000000
--- a/crontab
+++ /dev/null
@@ -1,2 +0,0 @@
-0 */3 * * * python3 /app/bot.py
-
diff --git a/exampleconfig.json b/exampleconfig.json
deleted file mode 100755
index 31418ce..0000000
--- a/exampleconfig.json
+++ /dev/null
@@ -1,13 +0,0 @@
-{
-    "logpath": "yc.log",
-    "blacklist": "posted_images.csv",
-    "texts": "texts/quotes.txt",
-    "base_tags": ["yaoi", "-muscle", "-comic", "-text"],
-    "search_tags": ["looking_at_another", "kiss", "trap", "2boys", "promare"],
-    "twitterapi":{
-        "consumer_key": "xxxxxxxxxxxxxxxxxxx",
-        "consumer_secret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
-        "access_token": "xxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxx",
-        "access_token_secret": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
-    }
-}
\ No newline at end of file
diff --git a/readme.md b/readme.md
deleted file mode 100755
index ea4c32b..0000000
--- a/readme.md
+++ /dev/null
@@ -1,33 +0,0 @@
-# yaoi communism twitter bot 
-
-Forked from the yuri version.
-
-Unlike the yuri version, we don't have an archive of images and sources
-to use. Instead, download yaoi images on the fly from safebooru.org.
-Designed to be run once an hour using a cron job.
-
-## Steps
-
-- `git clone https://github.com/jwansek/yaoi-communism`
-
-- `sudo pip3 install -r requirements.txt`
-
-- `mv exampleconfig.json config.json`
-
-- Populate `config.json` with API keys
-
-- `python3 bot.py`
-
-## Running in docker
-
-- `sudo docker-compose build`
-
-- `sudo docker-compose up -d`
-
-Should do everything by itself if you set the config file correctly
-
-To manually run (for testing):
-
-`sudo docker run -it --entrypoint python3 --rm jwansek/yaoi-communism /app/bot.py`
-
-![Example image](https://pbs.twimg.com/media/EgSA-hVXoAIXLbB?format=jpg&name=large)
-- 
cgit v1.2.3