lubimyczytacrss/README.md

34 lines
642 B
Markdown
Raw Permalink Normal View History

2022-06-04 06:12:32 +00:00
# lubimyczytacrss
lubimyczytacrss is an RSS feed generator for [lubimyczytac.pl](https://lubimyczytac.pl).
## How to use?
### Option 1: Use Docker
```shell
$ docker run -d \
-p 9234:9234 \
--name lubimyczytacrss \
kichiyaki/lubimyczytacrss:latest
```
Or via docker-compose:
```yaml
version: "3.6"
services:
lubimyczytacrss:
2022-09-08 06:37:12 +00:00
image: gitea.dwysokinski.me/kichiyaki/lubimyczytacrss:latest
2022-06-04 06:12:32 +00:00
restart: unless-stopped
ports:
- '9234:9234'
networks:
- default
```
## Available endpoints
### GET /api/v1/rss/authors/{authorID}
Returns the RSS feed of the newest books written by the author with the given ID.