Update 'README.md'
This commit is contained in:
parent
aece259e45
commit
07aa92ae93
14
README.md
14
README.md
@ -1,8 +1,8 @@
|
||||
# Multifeeder
|
||||
|
||||
Multifeeding RSS streams into an API.
|
||||
Multifeeding RSS streams.
|
||||
|
||||
This is the Multifeeder API :---), an Aggregated Publishing Interface supporting any kinds of publishing experiments. Currently the API is used to feed [Varia's TeleVex](https://televex.vvvvvvaria.org).
|
||||
This is the Multifeeder, a feed aggregator supporting any kinds of publishing experiments.
|
||||
|
||||
## Live
|
||||
|
||||
@ -12,9 +12,9 @@ Commits to this git repository will automagically update the live version!
|
||||
|
||||
(Multifeeder runs as a `supervisor` service, see `/etc/supervisor/conf.d/multifeeder.conf`.)
|
||||
|
||||
The API is updated every 10 minutes.
|
||||
The feeds are updated every 10 minutes.
|
||||
|
||||
## API
|
||||
## Access points
|
||||
|
||||
**/API/latest/[num]**
|
||||
|
||||
@ -22,7 +22,7 @@ For example: https://multi.vvvvvvaria.org/API/latest/5
|
||||
|
||||
(for the latest 5 posts in all feeds)
|
||||
|
||||
Format: `JSON`
|
||||
Format: `JSON` (default) & `Markdown`
|
||||
|
||||
**/API/today/**
|
||||
|
||||
@ -30,7 +30,7 @@ For example: https://multi.vvvvvvaria.org/API/today/
|
||||
|
||||
(for the posts published today)
|
||||
|
||||
Format: `JSON`
|
||||
Format: `JSON` (default) & `Markdown`
|
||||
|
||||
**/API/past/[days]**
|
||||
|
||||
@ -38,7 +38,7 @@ For example: https://multi.vvvvvvaria.org/API/past/30
|
||||
|
||||
(for all the posts published in the last 30 days)
|
||||
|
||||
Format: `JSON`
|
||||
Format: `JSON` (default) & `Markdown`
|
||||
|
||||
## Add a feed
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user