chore: updated README ddbbe8a5
Steve Simkins · 2026-07-07 19:26 1 file(s) · +19 −1
README.md +19 −1
1 1 
# feeds
2 2 

            

            
            

                
                3
                +
                
![cover](https://files.stevedylan.dev/feeds-software-demo.png)

            

            
            

                
                4
                +
                

            

            
            

                
                5
                +
                
*An introduction to RSS*

            

            
            

                
                6
                +
                

            

            
            

                3
                7
                 
                
Small Go server that merges multiple RSS/Atom feeds into one combined view. Paste feed URLs (or a site URL to auto-discover its feed) and see recent items sorted together.

            

            
            

                4
                8
                 
                

            

            
            

                5
                9
                 
                
## Run

            

            
        
            

            
            

                8
                12
                 
                
go run .

            

            
            

                9
                13
                 
                
```

            

            
            

                10
                14
                 
                

            

            
            

                11
                
                -
                
Server starts on `:3000` (override with `PORT`/`HOST`/`BASE_URL` env vars).

            

            
            

                
                15
                +
                
Server starts on `:3000`. Override with env vars:

            

            
            

                
                16
                +
                

            

            
            

                
                17
                +
                
- `HOST` (default `0.0.0.0`)

            

            
            

                
                18
                +
                
- `PORT` (default `3000`)

            

            
            

                
                19
                +
                
- `BASE_URL` (default `http://localhost:3000`)

            

            
            

                12
                20
                 
                

            

            
            

                13
                21
                 
                
## Build

            

            
            

                14
                22
                 
                

            

            
        
            

            
            

                17
                25
                 
                
./feeds

            

            
            

                18
                26
                 
                
```

            

            
            

                19
                27
                 
                

            

            
            

                
                28
                +
                
## Docker

            

            
            

                
                29
                +
                

            

            
            

                
                30
                +
                
```sh

            

            
            

                
                31
                +
                
docker compose up

            

            
            

                
                32
                +
                
```

            

            
            

                
                33
                +
                

            

            
            

                
                34
                +
                
Or build the image directly from the included `Dockerfile`.

            

            
            

                
                35
                +
                

            

            
            

                20
                36
                 
                
## Usage

            

            
            

                21
                37
                 
                

            

            
            

                22
                38
                 
                
- Open `http://localhost:3000`, add feed URLs, and view merged items.

            

            
            

                23
                39
                 
                
- `GET /?urls=<comma-separated-feed-urls>` — renders merged feed items server-side.

            

            
            

                24
                40
                 
                
- `GET /api/resolve?url=<url>` — resolves a feed or site URL to its feed(s) as JSON.

            

            
            

                
                41
                +
                
- `GET /og.png` — dynamically generated Open Graph image.

            

            
            

                
                42
                +
                
- `GET /privacy` — privacy page.

            

            
            

                25
                43
                 
                

            

            
            

                26
                44
                 
                
## License

            

            
            

                27
                45