From fa9936c0faf664513e051c4e00cf7f2bcc72e837 Mon Sep 17 00:00:00 2001 From: Tomasz Kapias Date: Sat, 18 Feb 2023 14:55:09 +0100 Subject: [PATCH] readme update Signed-off-by: Tomasz Kapias --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f58be56..5e65510 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Generates OPML 2.0 files to track the syndication of Releases from your favorite ## Introduction -Each repository's Releases page on Github has a link to an atom file. +Each repository's Releases page on Github has a [link](https://github.com/user/repository/releases.atom) to an atom file. This **syndication feeds** allows, among other things : - to monitor the appearance of new releases, @@ -16,13 +16,13 @@ This **syndication feeds** allows, among other things : Moreover with the recent feature of **[starred repositories lists](https://github.blog/changelog/2021-12-09-lists-are-now-available-as-a-public-beta/)**, you can choose to **follow only some personal categories** of releases. -- The **1st issue** lies in the fact tha **Github's interface does not provide** any feature to **export** thoses atom file in bulk. +- The **1st issue** lies in the fact tha **Github's interface does not provide** any feature to **export** these atom file in bulk. - Github's API does provide an [endpoint](https://docs.github.com/en/rest/activity/starring?apiVersion=2022-11-28#list-repositories-starred-by-a-user) to fetch all the repositories starred by an user, it's easy to generate the atom list from here. +- Github's API does provide an [endpoint](https://docs.github.com/en/rest/activity/starring?apiVersion=2022-11-28#list-repositories-starred-by-a-user) to fetch all the repositories starred by an user, it's easy to generate the atom list from here. - But, a **2nd issue** is that this **[API does not yet provide](https://github.com/community/community/discussions/8293)** an endpoint to **filter the starred repositories by a List** created by the user. -**gh-starred-to-opml** is a script that will fetch these informations for you and generate a file that can be imported in most Feed Reader applications, like [Miniflux](https://github.com/miniflux/v2). +**gh-starred-to-opml** is a bash script that will fetch these informations for you and generate a file that can be imported in most Feed Reader applications, like [Miniflux](https://github.com/miniflux/v2). ## Requirements