From 5c73399f5cf459a264984c0019f3c7e60f4684c8 Mon Sep 17 00:00:00 2001
From: Lightling <contact@lightling.xyz>
Date: Mon, 19 Feb 2024 12:32:30 -0500
Subject: [PATCH] Update README.md

---
 README.md | 35 +++++++++++++++++++++++++----------
 1 file changed, 25 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 4573b0a..3ea6eca 100644
--- a/README.md
+++ b/README.md
@@ -22,13 +22,33 @@ Example:
 Runs a full download of all users listed in the db.json of the archive (the provided `--path`).
 
 Args:
-- `--path={/path/to/your/archive}` 
+- `--path={/path/to/your/archive}`
 - `--threads={#}`
 - `--args={gallery-dl args}`
 
 Example:
 - `node run-downloadDb.js --path=/mnt/data/archive --threads=3 --args="-r 2.5M"` will run a full download (`/media` followed by `/search` starting from the oldest pulled file from `/media`) of all the users in the `/mnt/data/archive/db.json` file, limiting concurrent download threads to 3. It will pass the additional args `-r 2.5M --no-skip` to the gallery-dl bin being executed; `-r 2.5M --no-skip` corresponds to limiting the download rate to 2.5M and downloading all files without skipping (for the sake of example).
 
+### `run-downloadUsers.js`
+
+Should add a new user to the db and initiate a full download similar to `run-downloadDb.js`
+
+Args:
+- `--path={/path/to/your/archive}`
+- `--users={comma,separated,userlist}`
+- `--threads={#}`
+
+### `run-convertDb.js`
+
+Converts `db.json` to the latest version. See `./lib/schema.js` for full db.json schema.
+
+Args:
+- `--path={/path/to/your/archive}`
+
+Historical Versions:
+- v0: simple array of users with `user`, `lastUpdated`, `lastError` fields
+- v1 (**CURRENT**): object with `version` and `userList` fields, `userList` containing key-value entries where the key is the username, the value is an informational object regarding that username.
+
 ## Args
 
 Standard args:
@@ -47,15 +67,6 @@ Additional args to pass to gallery-dl. See [gallery-dl CLI options](https://gith
 
 ## TODO
 
-### `run-addUsers.js`
-
-Should add a new user to the db and initiate a full download similar to `run-downloadDb.js`
-
-Args:
-- `--path={/path/to/your/archive}`
-- `--users={string array of user(s)}`
-- `--threads={#}`
-
 ### `run-updateDb.js`
 
 Should pull from the user database and update the archive without doing a full download. The DB should save with a lastUpdated field. This should be used as a date for the `/search` API. Preferred if it's been a long time since an update has happened for a user and/or the user has uploaded a significant amount of media since lastUpdated.
@@ -76,3 +87,7 @@ Args:
 - `--full={true|false}`
 - `--path={/path/to/your/archive}`
 - `--args={gallery-dl args}`
+
+### Rename Detection
+
+Should detect renames when running `/search`. Occasionally `/media` will fail due to the rename, but `/search` will return results, causing a full download from `/search` and adding the user to the db without notice. This should stop the download and print out an error that they've been updated from `username` to `username`. Because the command will have already finished `/media` and thus be halfway through the process, this should be done manually after the command has finished.