diff --git a/README.md b/README.md index 86f76e5..47f2be6 100644 --- a/README.md +++ b/README.md @@ -1 +1,52 @@ -# ascendance-of-a-bookworm-bot \ No newline at end of file +# ascendance-of-a-bookworm-bot + +**secrets.json** +```json +{ + "lemmy": { + "username": "string", + "password": "string" + }, + "reddit": { + "app_id": "string", + "app_secret": "string", + "refresh_token": "string", + "redirect_uri": "string" + }, + "discord": {} +} +``` + +**config.json** +```json +{ + "instance": "string", + "reddit_config": { + "user_agent": "string", + "subreddit": "string" + }, + "feeds": [ + { + "feed_url": "string", + "communities": { + "chapter": "string", + "volume": "string" + }, + "reddit": { + "enabled": bool, + "flair": "string" + }, + "discord": bool + } + ] +} +``` + +posts.json +```json +[ + { + "title", + "last_post_url": "string" + } +] \ No newline at end of file