adding API details to the README
This commit is contained in:
parent
3b662460a2
commit
7595b5c31f
34
README.md
34
README.md
@ -1,20 +1,48 @@
|
||||
# Multifeeder
|
||||
|
||||
Multifeeding RSS streams into a point of access to publish from!
|
||||
Multifeeding RSS streams into a point of access.
|
||||
|
||||
## Live
|
||||
|
||||
Multifeeder runs here: <https://multi.vvvvvvaria.org/>
|
||||
|
||||
Commits to this git will automagically update the live version!
|
||||
Commits to this git repository will automagically update the live version!
|
||||
|
||||
(Multifeeder runs as a `supervisor` service, see `/etc/supervisor/conf.d/multifeeder.conf`.)
|
||||
|
||||
## API
|
||||
|
||||
### /API/latest/[num]
|
||||
|
||||
For example: https://multi.vvvvvvaria.org/API/latest/5
|
||||
|
||||
(for the latest 5 posts in all feeds)
|
||||
|
||||
Format: `JSON`
|
||||
|
||||
### /API/today/
|
||||
|
||||
For example: https://multi.vvvvvvaria.org/API/today/
|
||||
|
||||
(for the posts published today)
|
||||
|
||||
Format: `JSON`
|
||||
|
||||
### /API/past/[days]
|
||||
|
||||
For example: https://multi.vvvvvvaria.org/API/past/30
|
||||
|
||||
(for all the posts published in the last 30 days)
|
||||
|
||||
Format: `JSON`
|
||||
|
||||
## Add a feed
|
||||
|
||||
Feeds can be added here in the git, by editing the file `feeds.txt`.
|
||||
|
||||
Leave a feed link on a new line, commit your change, and the Multifeeder will be include the feed.
|
||||
Leave a feed link on a new line, commit your change, and the feed will be included in the Multifeeder.
|
||||
|
||||
Removing a feed can be done by taking a feed link out of this list.
|
||||
|
||||
## Using the multifeeder locally
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user