From d7d37a579e65e586c2fefa2109a7b280272fdf30 Mon Sep 17 00:00:00 2001
From: yggverse <yggverse@project>
Date: Tue, 11 Feb 2025 19:27:32 +0200
Subject: [PATCH] update readme

---
 README.md | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 2432650..54fa97a 100644
--- a/README.md
+++ b/README.md
@@ -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