ref: adede4451d10409f7d7ebf089817a5fbb845d261 openring/README.md -rw-r--r-- 1.5 KiB View raw
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# openring

This is a tool for generating a webring from RSS feeds, so you can link to
other blogs you like on your own blog. It's designed to be fairly simple and
integrate with any static site generator. The basic usage is:

```
openring \
  -s https://drewdevault.com/feed.xml \
  -s https://emersion.fr/blog/rss.xml \
  -s https://danluu.com/atom.xml \
  < in.html \
  > out.html
```

This will read the template at in.html (an example is provided, but feel free to
adjust it to suit your needs), fetch the latest 3 articles from among your
sources, and pass them to the template and write the output to out.html. Then
you can include this file with your static site generator's normal file include
mechanism.

A pre-compiled binary is available [here](https://yukari.sr.ht/openring) so you
can integrate this with your CI deploy. For example, on
[builds.sr.ht](https://sourcehut.org), add a step like this to your
`.build.yml`:

```yaml
tasks:
  - openring: |
      curl -O https://yukari.sr.ht/openring
      chmod +x openring
      ./openring \
        -s https://drewdevault.com/feed.xml \
        -s https://emersion.fr/blog/rss.xml \
        -s https://danluu.com/atom.xml \
        < _include/webring-in.html \
        > _include/webring-out.html
# ...
```

## Contributing

Want to help? [Send patches](https://git-send-email.io) to the [mailing
list](https://lists.sr.ht/~sircmpwn/public-inbox):
[`~sircmpwn/public-inbox@lists.sr.ht`](mailto:~sircmpwn/public-inbox@lists.sr.ht).
Thanks!

---

![Screenshot of a generated web ring](https://sr.ht/TRrJ.png)