aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorjwansek <eddie.atten.ea29@gmail.com>2025-09-27 22:53:12 +0100
committerjwansek <eddie.atten.ea29@gmail.com>2025-09-27 22:53:12 +0100
commit4762a8dff33643e2169e8f2e8c91ac66c7822c68 (patch)
tree0e96285ec2a7855d678ae30625dca3339ce62ec9 /README.md
parent3b2bbf199db2bd3a38e18c821114d1df97f2dd5e (diff)
downloadyaoi-communism-4762a8dff33643e2169e8f2e8c91ac66c7822c68.tar.gz
yaoi-communism-4762a8dff33643e2169e8f2e8c91ac66c7822c68.zip
Updated README.mdHEADmaster
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md21
1 files changed, 21 insertions, 0 deletions
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)