Keep up with master changes

[github/shaarli/Shaarli.git] / doc / RSS-feeds.md

diff --git a/doc/RSS-feeds.md b/doc/RSS-feeds.md
index 764b3a49027f60004b944d051bc8265cffb41865..757bed9ab3663041734b670c2cad264a18a0fecc 100644 (file)
--- a/doc/RSS-feeds.md
+++ b/doc/RSS-feeds.md
@@ -1,5 +1,17 @@
 #RSS feeds
+### Feeds options
+
+Feeds are available in ATOM with `?do=atom` and RSS with `do=RSS`.
+
+Options:
+- You can use `permalinks` in the feed URL to get permalink to Shaares instead of direct link to shaared URL.
+    - E.G. `https://my.shaarli.domain/?do=atom&permalinks`.
+- You can use `nb` parameter in the feed URL to specify the number of Shaares you want in a feed (default if not specified: `50`). The keyword `all` is available if you want everything.
+    - `https://my.shaarli.domain/?do=atom&permalinks&nb=42`
+    - `https://my.shaarli.domain/?do=atom&permalinks&nb=all`
+
 ### RSS Feeds or Picture Wall for a specific search/tag
+
 It is possible to filter RSS/ATOM feeds and Picture Wall on a Shaarli to **only display results of a specific search, or for a specific tag**.
 
 For example, if you want to subscribe only to links tagged `photography`: