Skip to content

Commit

Permalink
Update README, include discuss links
Browse files Browse the repository at this point in the history
  • Loading branch information
imorland committed Jun 10, 2021
1 parent 15c7be3 commit f26d6d2
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
[![MIT license](https://img.shields.io/static/v1?label=license&message=CeCILL-B&color=blue)](https://github.com/imorland/syndication/blob/master/LICENSE)
[![Latest Stable Version](https://img.shields.io/packagist/v/ianm/syndication.svg)](https://packagist.org/packages/ianm/syndication)
[![Total Downloads](https://img.shields.io/packagist/dt/ianm/syndication.svg)](https://packagist.org/packages/ianm/syndication)
[![Compatibility](https://flarum-badge-api.davwheat.dev/v1/compat-latest/ianm/syndication)](https://flarum-badge-api.davwheat.dev/v1/compat-latest/fof/drafts)

# Syndication for [Flarum](https://flarum.org)

Brings RSS and Atom feeds to Flarum.

Based on https://github.com/AmauryCarrade/flarum-ext-syndication, seemingly now abandoned.
Based on [`amaurycarrade/flarum-ext-syndication`](https://github.com/AmauryCarrade/flarum-ext-syndication), seemingly now abandoned. This fork, and the changes required to bring this extension back to life were sponsored by [010101](https://discuss.flarum.org/u/010101)

Compatible with Flarum v1.0 and above

### Installation

Expand All @@ -20,8 +27,16 @@ This extension adds the following feeds to Flarum:
- `/atom/t/tag/discussions`: feed with the newly created discussions in the given tag;
- `/atom/d/21-discussion-slug`: feed with the recent posts in the given discussion.

You can replace `atom` by `rss` in the URLs above to get RSS feeds instead. The tags-related feeds are only available if the tags extension is installed and enabled.
You can replace `atom` by `rss` in the URLs above to get RSS feeds instead. The tags-related feeds are only available if `flarum/tags` is installed and enabled.

You can also add `?sort=latest|top|newest|oldest` to the discussions lists feeds to sort the feed, and `?q=<search>` to filter it. Or both using `?sort=<sorting>&q=<search>`.

Feeds are linked in the pages for autodiscovery. This said, they are not dynamically updated as the page change (except when fully reloaded), earlier because of this [Firefox bug](https://bugzilla.mozilla.org/show_bug.cgi?id=380639), and now because even Firefox no longer display RSS feeds in the browser.

### Links

- [Flarum Discuss post](https://discuss.flarum.org/d/)
- [Source code on GitHub](https://github.com/imorland/syndication)
- [Report an issue](https://github.com/imorland/syndication)
- [Packagist](https://packagist.org/packages/ianm/syndication)
- [Extiverse](https://extiverse.com/extension/ianm/syndication)
6 changes: 3 additions & 3 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"support": {
"issues": "https://github.com/imorland/syndication/issues",
"source": "https://github.com/imorland/syndication",
"forum": "https://discuss.flarum.org/d/"
"forum": "https://discuss.flarum.org/d/27687"
},
"authors": [
{
Expand All @@ -24,7 +24,7 @@
}
],
"require": {
"flarum/core": "^1.0.0"
"flarum/core": "^1.0.2"
},
"extra": {
"flarum-extension": {
Expand All @@ -42,7 +42,7 @@
]
},
"flagrow": {
"discuss": "https://discuss.flarum.org/d/"
"discuss": "https://discuss.flarum.org/d/27687"
}
},
"autoload": {
Expand Down

0 comments on commit f26d6d2

Please sign in to comment.