Switch Readme to toml config
This commit is contained in:
parent
594d3e08fe
commit
c62cd1e285
1 changed files with 31 additions and 24 deletions
55
README.md
55
README.md
|
@ -17,36 +17,43 @@
|
|||
}
|
||||
```
|
||||
|
||||
**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
|
||||
}
|
||||
]
|
||||
}
|
||||
**config.toml**
|
||||
```toml
|
||||
[urls]
|
||||
instance = "base URL of Lemmy Instance"
|
||||
uptime_kuma = "Uptime Kuma Ping URL"
|
||||
|
||||
[settings]
|
||||
config_reload = 360 # Time in Minutes between Config reloads
|
||||
|
||||
|
||||
[[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_post_url": "string"
|
||||
"last_volume_slug": "string",
|
||||
"last_volume_time": "string",
|
||||
"last_part_slug": "string",
|
||||
"last_part_time": "string"
|
||||
}
|
||||
]
|
Loading…
Reference in a new issue