diff options
Diffstat (limited to 'README.md')
| -rwxr-xr-x | README.md | 21 |
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`
+
+
|