add README

This commit is contained in:
ewin 2025-03-27 10:57:23 -04:00
parent 4d3b43adca
commit 8497814fa4
Signed by: erin
SSH key fingerprint: SHA256:swjoHhREbZPbWe+gyJNi24d4NAxJSyUIm3fpZj4z3wc

7
README.md Normal file
View file

@ -0,0 +1,7 @@
# ffxiv-wiki-edb-id-script
Wiki bot for https://ffxiv.consolegameswiki.com that attempts to fix items in [Category:Missing EDB ID](https://ffxiv.consolegameswiki.com/wiki/Category:Missing_EDB_ID) by looking them up in Eorzea Database and adding the appropriate `id-edb` infobox parameter.
## Usage
You'll need Node.js and npm. Install dependencies via `npm ci`, set `MW_USERNAME` and `MW_PASSWORD` to your account username and bot password respectively, then run `node edb-id-bot.mjs`.