Commit477389beRecorded3 Apr 2026Repositorysigil-rss
Add README with usage examples and module overview
Message
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
Changed
README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 54 insertions(+)Diff
README.mdadded
@@ -0,0 +1,54 @@
+1
# sigil-rss+2
+3
RSS/Atom feed parsing library for [Sigil](https://codeberg.org/sigil/sigil).+4
+5
## Features+6
+7
- Parse RSS 2.0 and Atom feeds into common structs+8
- Auto-detect feed format+9
- Fetch feeds over HTTP/HTTPS+10
- Graceful handling of missing or malformed fields+11
+12
## Usage+13
+14
```scheme+15
(import (sigil rss parser)+16
(sigil rss fetcher)+17
(sigil rss types))+18
+19
;; Fetch and parse a feed+20
(let ((f (fetch-feed "https://example.com/feed.xml")))+21
(display (feed-title f))+22
(for-each (lambda (entry)+23
(display (feed-entry-title entry))+24
(newline))+25
(feed-entries f)))+26
+27
;; Parse from a string (auto-detects RSS vs Atom)+28
(let ((f (parse-feed xml-string)))+29
(feed-format f)) ; => 'rss or 'atom+30
```+31
+32
## Modules+33
+34
- `(sigil rss types)` - `feed` and `feed-entry` structs+35
- `(sigil rss parser)` - `parse-rss`, `parse-atom`, `parse-feed`+36
- `(sigil rss fetcher)` - `fetch-feed`, `fetch-feeds`+37
+38
## Dependencies+39
+40
- `sigil-stdlib` ^0.9.0+41
- `sigil-http` ^0.9.0+42
- `sigil-sxml` ^0.9.0+43
+44
## Build+45
+46
```+47
sigil deps install+48
sigil build+49
sigil test+50
```+51
+52
## License+53
+54
BSD-3-Clause