Skip to content

Commit 20c3a32

Browse files
committed
Update README.md
1 parent a458092 commit 20c3a32

File tree

1 file changed

+26
-10
lines changed

1 file changed

+26
-10
lines changed

README.md

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
This is a small service that turns your GitHub notifications into an RSS feed.
44

5-
You give it a GitHub personal access token.
6-
It calls the `/notifications` API, filters the data, and serves a clean RSS 2.0 feed that your reader can subscribe to.
5+
You give it a GitHub personal access token.
6+
It calls the `/notifications` API, filters the data, and serves an RSS 2.0 feed that your reader can subscribe to.
77

88
## What it does
99

@@ -16,13 +16,29 @@ It calls the `/notifications` API, filters the data, and serves a clean RSS 2.0
1616
- `/feed` for the RSS feed
1717
- `/health` for a simple JSON status
1818

19-
The RSS items look roughly like this:
19+
Descriptions can be HTML or plain text, depending on config.
2020

21-
- Title: `[owner/repo] Issue or PR title`
22-
- Link: direct link to the issue, pull request, commit or release
23-
- Description: reason, type, repo, unread flag and timestamps
21+
## Example feed item
2422

25-
Descriptions can be HTML or plain text, depending on config.
23+
In a typical RSS reader a single item might look like this:
24+
25+
**Title**
26+
27+
`[timkicker/podliner] Fix MPV logging path on Linux`
28+
29+
**Body**
30+
31+
```bash
32+
[mention] [Pull request] 🔔
33+
Fix MPV logging path on Linux
34+
35+
Repo: timkicker/podliner
36+
Reason: mention
37+
Type: Pull request
38+
Unread: yes
39+
Repo link: https://github.com/timkicker/podliner
40+
Updated: 2025-11-14T06:56:00+00:00
41+
```
2642

2743
## Quick start with Docker
2844

@@ -34,7 +50,7 @@ cp .env.example .env
3450

3551
Edit `.env` and set at least:
3652

37-
```env
53+
```bash
3854
GITHUB_TOKEN=ghp_your_token_here
3955
```
4056

@@ -93,7 +109,7 @@ BIND_ADDR=0.0.0.0
93109
BIND_PORT=8000
94110
```
95111

96-
You can tune this later when you know what kind of notifications you want to see or hide. For many people the defaults should be fine.
112+
You can adjust this later when you know what kind of notifications you want to see or hide. For many setups the defaults should be fine.
97113

98114
## Status endpoint
99115

@@ -108,7 +124,7 @@ The `/health` endpoint returns a small JSON payload, for example:
108124
}
109125
```
110126

111-
- `ok` means last fetch worked
127+
- `ok` means the last fetch worked
112128
- `degraded` means GitHub failed but an older cached feed is still served
113129
- `error` means there is no valid cache and the last fetch failed
114130

0 commit comments

Comments
 (0)