chore: add readme and license 258f3f48
Steve Simkins · 2026-07-05 09:44 2 file(s) · +50 −0
LICENSE (added) +22 −0
1 +
MIT License
2 +
3 +
Copyright (c) 2026 Steve Simkins
4 +
5 +
Permission is hereby granted, free of charge, to any person obtaining a copy
6 +
of this software and associated documentation files (the "Software"), to deal
7 +
in the Software without restriction, including without limitation the rights
8 +
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 +
copies of the Software, and to permit persons to whom the Software is
10 +
furnished to do so, subject to the following conditions:
11 +
12 +
The above copyright notice and this permission notice shall be included in all
13 +
copies or substantial portions of the Software.
14 +
15 +
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 +
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 +
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 +
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 +
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 +
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 +
SOFTWARE.
22 +
README.md (added) +28 −0
1 +
# feeds
2 +
3 +
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 +
5 +
## Run
6 +
7 +
```sh
8 +
go run .
9 +
```
10 +
11 +
Server starts on `:3000` (override with `PORT`/`HOST`/`BASE_URL` env vars).
12 +
13 +
## Build
14 +
15 +
```sh
16 +
go build -o feeds .
17 +
./feeds
18 +
```
19 +
20 +
## Usage
21 +
22 +
- Open `http://localhost:3000`, add feed URLs, and view merged items.
23 +
- `GET /?urls=<comma-separated-feed-urls>` — renders merged feed items server-side.
24 +
- `GET /api/resolve?url=<url>` — resolves a feed or site URL to its feed(s) as JSON.
25 +
26 +
## License
27 +
28 +
[MIT](LICENSE)