pulsarss/README.md
2025-02-11 19:27:32 +02:00

28 lines
No EOL
1.2 KiB
Markdown

# 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)
`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
``` bash
cargo install pulsarss
```
## Launch
``` bash
pulsarss --source https://path/to/feed.rss
```
### Options
* `source` - RSS feed source (required)
* `target` - Destination directory (`public` by default)
* `update` - Update timeout in seconds (`60` by default)