aboutsummaryrefslogtreecommitdiffstats
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
parent3b2bbf199db2bd3a38e18c821114d1df97f2dd5e (diff)
downloadyaoi-communism-master.tar.gz
yaoi-communism-master.zip
Updated README.mdHEADmaster
-rwxr-xr-xDockerfile1
-rwxr-xr-xREADME.md (renamed from readme.md)20
-rwxr-xr-xconfig.json.example (renamed from exampleconfig.json)0
-rwxr-xr-xcrontab2
4 files changed, 5 insertions, 18 deletions
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
index ea4c32b..7b84dfe 100755
--- a/readme.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# yaoi communism twitter bot
+# Yaoi Communism Twitter Bot
Forked from the yuri version.
@@ -6,28 +6,16 @@ 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 build`
-- `sudo docker-compose up -d`
+- `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`
+`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/exampleconfig.json b/config.json.example
index 31418ce..31418ce 100755
--- a/exampleconfig.json
+++ b/config.json.example
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
-