aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
authorjwansek <eddie.atten.ea29@gmail.com>2020-08-25 17:46:13 +0000
committerjwansek <eddie.atten.ea29@gmail.com>2020-08-25 17:46:13 +0000
commitebc74eb418ce3728624dbb36df60d5b645b2aaf5 (patch)
tree41a37e7881032ea15d8a470b44d67a7f307be5de /readme.md
parente6d64b2408608c3606235a8e087b8e150332af24 (diff)
downloadyaoi-communism-ebc74eb418ce3728624dbb36df60d5b645b2aaf5.tar.gz
yaoi-communism-ebc74eb418ce3728624dbb36df60d5b645b2aaf5.zip
updated readme
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 9432f1f..2eff7ae 100644
--- a/readme.md
+++ b/readme.md
@@ -5,3 +5,17 @@ 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`
+
+![Example image](https://pbs.twimg.com/media/EgSA-hVXoAIXLbB?format=jpg&name=large)