diff --git a/README.md b/README.md index 1a57ada..b2bb44f 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,57 @@ # 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": {} -} +**.env** +```bash +LEMMY_USERNAME="BotUserName" +LEMMY_PASSWORD="BotPassword" ``` +*Note: Passwords containing special characters might need to be escaped using '\'* **config.toml** ```toml -[urls] -instance = "base URL of Lemmy Instance" -uptime_kuma = "Uptime Kuma Ping URL" +instance = "https://lemmy.example.org" +status_post_url = "PostUrlForStatusMonitoring" +config_reload_seconds = 10800 -[settings] -config_reload = 360 # Time in Minutes between Config reloads +protected_communities = [ "community_where_pins_should_stay" ] +[[series]] +slug = "example-slug" +parted = false +[series.prepub_community] +name = "communityforprepubs" +[series.prepub_community.pin_settings] +pin_new_post_local = true +pin_new_post_community = true +[series.prepub_community.post_body] +body_type = "Custom" +body_content = """ +Custom Text for the Post\n\n\ +Can contain new lines and [links](https://join-lemmy.org)""" +[series.volume_community] +name = "communityforvolumes" +[series.volume_community.pin_settings] +pin_new_post_local = false +pin_new_post_community = true +[series.volume_community.post_body] +body_type = "Description" -[[feeds]] -id = 0 # incrementor, only used for correctly matching post history data -series_slug = "ascendance-of-a-bookworm" # series slug on J-Novel Club - -[communities] -chapter = "aobprepub" # Community for Chapter Posts of the Series -volume = "aoblightnovel" # Community for Volume Posts of the Series - - -[[feeds]] # See previous example -id = 1 -series_slug = "ascendance-of-a-bookworm-short-story-collection" - -[communities] -chapter = "aobprepub" -volume = "aoblightnovel" -``` - -posts.json -```json -[ - { - "id": number, - "title", - "last_volume_slug": "string", - "last_volume_time": "string", - "last_part_slug": "string", - "last_part_time": "string" - } -] \ No newline at end of file +[[series]] +slug = "example-slug-2" +parted = true +[series.prepub_community] +name = "communityforprepubs" +[series.prepub_community.pin_settings] +pin_new_post_local = false +pin_new_post_community = false +[series.prepub_community.post_body] +body_type = "Custom" +body_content = "single line content" +[series.volume_community] +name = "communityforvolumes" +[series.volume_community.pin_settings] +pin_new_post_local = false +pin_new_post_community = false +[series.volume_community.post_body] +body_type = "None" +``` \ No newline at end of file