diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b4858c --- /dev/null +++ b/README.md @@ -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`.