From 76da48766c562c43a65db4e25030ea3acb16d34c Mon Sep 17 00:00:00 2001 From: IwanIDev Date: Sat, 21 Mar 2026 15:50:35 +0000 Subject: feat: integrate Openring for webring section and update related files --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 494ec00..4db02bf 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,29 @@ # Astro Blog Site This is my blog site written with Astro, Tailwind CSS, and shadcn/ui. -**WORK IN PROGRESS** +## Openring integration + +This project integrates [`openring`](https://git.sr.ht/~sircmpwn/openring) to render a webring section on the homepage. + +### How it works + +- Feed sources are defined in `openring/feeds.txt`. +- The template is defined in `openring/template.html`. +- Generated output is written to `openring/out.html`. +- `bun run dev` and `bun run build` both run `bun run openring:generate` first. + +### Install openring + +Install the `openring` binary (example using Go): + +```bash +go install git.sr.ht/~sircmpwn/openring@latest +``` + +Make sure your Go bin directory is in `PATH`, then generate output: + +```bash +bun run openring:generate +``` + +If `openring` is not installed (or feed fetch fails), the generator writes a small fallback section so builds still succeed. -- cgit