diff --git a/README.md b/README.md index 25c9184..f0f50e3 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,28 @@ # misskey gooner remover 3000 -simple nodejs script to remove inactive accounts on sharkey / misskey fediverse instances +Simple nodejs script to remove inactive accounts on sharkey / misskey fediverse instances -## installation +## Installation -``` -bun install -node main.js +1. Install bun and run: -``` + ```text + bun install + node main.js + ``` + +## Create env file + +1. Create an API key with the permissions + - Delete user account + - View private user info + +2. Create a `.env` file in the current directory with: + + ```env + USER_TOKEN=token + INSTANCE_URL=https://example.com + PERIOD=int // Time in days + ``` License: MIT