From e7698c52c9bb9d86de9532e409284f05346e47bd Mon Sep 17 00:00:00 2001
From: Leonetienne <leonetienne@hotmail.de>
Date: Sun, 30 Jan 2022 03:49:51 +0100
Subject: [PATCH] readme

---
 launch.py => grab-all.py |  0
 readme.md                | 29 +++++++++++++++++++++++++++++
 required-packages.txt    |  2 +-
 3 files changed, 30 insertions(+), 1 deletion(-)
 rename launch.py => grab-all.py (100%)
 create mode 100644 readme.md

diff --git a/launch.py b/grab-all.py
similarity index 100%
rename from launch.py
rename to grab-all.py
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..4cade0a
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,29 @@
+# Quick-and-dirty artstation sync
+This is a personal and untested tool to keep (and update) local copies of artstation profiles via cli.
+Project id's are saved in order to not re-download everything. This ensures that only new media will be downloaded in each cronjob instance.
+No fancy bs going on. Just a simple script bodged together within 10 minutes at 3 AM.
+
+Currently only working for images. Feel free to issue a pull request if you want more.
+
+## Setup
+Install required pip modules.
+```bash
+pip3 install request pyyaml
+```
+All scripts require Python3. Tested using 3.9.9.
+
+## Running it
+Here we have two scripts:
+```bash
+grab.py $artist-name
+```
+This will grab one individual profile, if it is not already downloaded.
+
+```bash
+grab-all.py
+```
+This will call `grab.py` on all artists listed in `artists.yaml`.
+
+Files will be saved to `./downloads/{artist_name}/*.{ext}`.
+Logs will be saved to `./logs/{artist_name}.txt`.
+Download indices (to skip already downloaded projects) are kept in `./already_saved/{artist_name}.txt`.
diff --git a/required-packages.txt b/required-packages.txt
index 03a040b..5052a3f 100644
--- a/required-packages.txt
+++ b/required-packages.txt
@@ -1,4 +1,4 @@
 install these via pip3
 
-request
+requests
 pyyaml