commit ca695dfa422d4e19a221c921076208d64fe92774
parent af832aab4120e1f039f89fc92f9e277beb639b8e
Author: Kebigon <git@kebigon.xyz>
Date: Tue, 5 Feb 2019 21:22:18 +0900
Enhance README
Diffstat:
| M | README.md | | | 48 | ++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 48 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -1,2 +1,50 @@
# YuzuRSS
RSS aggregator microservice based on Spring Webflux
+
+## Usage
+
+Just send a POST request to /feed/, with in the body of the request a JSON object with the below:
+
+| Parameter | Description |
+| --------- | ------------------------------------------- |
+| limit | Number of feed entries to be provided |
+| urls | List of RSS/Atom/RDF feed URLs to aggregate |
+
+Example:
+
+ POST http://5.39.83.109:8091/feed/
+
+ {
+ "limit": 20,
+ "urls": [
+ "https://www.youtube.com/feeds/videos.xml?user=epenser1",
+ "https://www.youtube.com/feeds/videos.xml?user=scilabus",
+ "https://www.youtube.com/feeds/videos.xml?user=TroncheEnBiais"
+ ]
+ }
+
+The response will be a JSON list of entry, with the below:
+
+| Parameter | Description |
+| --------- | ---------------------------------------------------------------------- |
+| title | Title of the entry |
+| link | Link to open the content of the entry |
+| published | Time the entry has been published, format 2019-01-27T09:40:02.000+0000 |
+| author | Name of the author of the entry |
+
+Example:
+
+ [
+ {
+ "title": "\"Métaphysique et Zététique\" Entretien Sceptique avec Sardoche",
+ "link": "https://www.youtube.com/watch?v=WxNQp0fDFg0",
+ "published": "2019-01-27T09:40:02.000+0000",
+ "author": "La Tronche en Biais"
+ },
+ {
+ "title": "#06 L'odorat, partie 2 - Les sens humains - e-penser",
+ "link": "https://www.youtube.com/watch?v=VQjutS-MBUc",
+ "published": "2019-01-20T14:05:57.000+0000",
+ "author": "e-penser"
+ }
+ ]
