YGGverse/pulsarss
1
0
Fork 0
mirror of https://github.com/YGGverse/pulsarss.git synced 2026-03-31 09:05:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
yggverse 2025-02-11 19:27:32 +02:00
parent ffc2195f7d
commit d7d37a579e
1 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -1,10 +1,13 @@
# pulsarss
# RSS Aggregator for [Gemini Protocol](https://geminiprotocol.net/)
![Build](https://github.com/YGGverse/pulsarss/actions/workflows/build.yml/badge.svg)
[![Dependencies](https://deps.rs/repo/github/YGGverse/pulsarss/status.svg)](https://deps.rs/repo/github/YGGverse/pulsarss)
[![crates.io](https://img.shields.io/crates/v/pulsarss.svg)](https://crates.io/crates/pulsarss)
RSS Aggregator for [Gemini Protocol](https://geminiprotocol.net/)
`pulsarss` is a multi-process crawler for RSS feeds. It collects the data into static [gemtext](https://geminiprotocol.net/docs/gemtext.gmi) files, organized in sub-folders by `pub_date`. It also builds an actual `index.gmi` file in the destinations for easy reading in your favorite [Gemini browser](https://github.com/kr1sp1n/awesome-gemini#clients).
> [!NOTE]
> At this moment, `pulsarss` does not provide any built-in server. To read the data collected, use any server for static files listed in the [awesome-gemini list](https://github.com/kr1sp1n/awesome-gemini#servers)
## Install