From 5cd085e1a6ac2d474d68ff51e86a5b4be04f1a87 Mon Sep 17 00:00:00 2001 From: Tomasz Kapias Date: Sat, 18 Feb 2023 15:44:04 +0100 Subject: [PATCH] update readme Signed-off-by: Tomasz Kapias --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5e65510..8dd2b74 100644 --- a/README.md +++ b/README.md @@ -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** these atom file in bulk. +- The **1st issue** lies in the fact that **Github's interface does not provide** any feature to **export** these atom URLs 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. +- However, 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 (60 query per hour without auth). -- 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. +- But, a **2nd issue** is that the **[API does not yet provide](https://github.com/community/community/discussions/8293)** an endpoint to **filter the starred repositories by the user's personal Lists**. -**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). +**gh-starred-to-opml is a solution**, it's a bash script that will fetch these informations for you and generate a file that can be imported in most Feed Reader applications, like the selfhosted and open source [Miniflux](https://github.com/miniflux/v2). ## Requirements @@ -55,6 +55,7 @@ options: The resulting file can be imported in a Feed Reader. - The first `` will provide the category's name. - `` & `` respresent the oldest & most recent dates where repositories in the list where starred. It can help for updates. + - The whole `` is parsed by the update option (-n) to do without any other option. ## Example @@ -87,4 +88,6 @@ Cropped OPML extract from my Favorites list: ## To be done Some repositories do not offer Releases but will update Tags to signify a milestone. -- See if I can add an option to track tags. \ No newline at end of file +- See if I can add an option to track tags. + +- Replace jq by [jaq](https://github.com/01mf02/jaq), which is much faster. \ No newline at end of file