@@ -5,8 +5,6 @@ This is a small service that turns your GitHub notifications into an RSS feed.
55You give it a GitHub personal access token.
66It calls the ` /notifications ` API, filters the data, and serves a clean RSS 2.0 feed that your reader can subscribe to.
77
8- ---
9-
108## What it does
119
1210- Fetches GitHub notifications using the official API
@@ -26,8 +24,6 @@ The RSS items look roughly like this:
2624
2725Descriptions can be HTML or plain text, depending on config.
2826
29- ---
30-
3127## Quick start with Docker
3228
3329Clone the repo and copy the example env file:
@@ -55,8 +51,6 @@ If your compose file maps port `8083:8000`, the feed is available at:
5551
5652Add ` http://localhost:8083/feed ` to your RSS reader and you are done.
5753
58- ---
59-
6054## Token and scopes
6155
6256You need a GitHub Personal Access Token (classic).
@@ -66,8 +60,6 @@ You need a GitHub Personal Access Token (classic).
6660- With private repositories:
6761 - include ` repo `
6862
69- ---
70-
7163## Basic configuration
7264
7365Most options are set through environment variables. There is a ` .env.example ` with all of them. The most useful ones:
@@ -103,8 +95,6 @@ BIND_PORT=8000
10395
10496You 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.
10597
106- ---
107-
10898## Status endpoint
10999
110100The ` /health ` endpoint returns a small JSON payload, for example:
@@ -122,8 +112,6 @@ The `/health` endpoint returns a small JSON payload, for example:
122112- ` degraded ` means GitHub failed but an older cached feed is still served
123113- ` error ` means there is no valid cache and the last fetch failed
124114
125- ---
126-
127115## License
128116
129117This project is licensed under the MIT License. See ` LICENSE ` for details.
0 commit comments