From 6663046169c9c55f5fb53da87f67a002db347dfe Mon Sep 17 00:00:00 2001
From: Mario Nachbaur <noreply@nauta.one>
Date: Tue, 14 Oct 2025 18:26:29 +0200
Subject: [PATCH] update README.md

---
 README.md      | 13 ++++++++++++-
 pyproject.toml |  2 +-
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d7a2f04..479dd77 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # ligo.at
 
-A decentralized links page powered by the [AT Protocol][atproto].
+A decentralized links page on top of [AT Protocol][atproto].
 
 ## dependencies
 
@@ -10,9 +10,20 @@ Install [uv][uv] and run `uv sync`.
 
 Use the `generate_secrets.py` script or run `make .env`.
 
+## synchronization
+
+`ligo.at` reads directly from the users' PDS. A small cache is used to serve profile pages quicker. The cache is updated on every profile write, and when requesting a profile with the `?reload` query parameter (any value, even empty). `ligo.at` also reads from the [Jetstream][jetstream], so updates made to a profile outside of `ligo.at` should also be available instantly.
+
 ## run
 
 Either start a debug server with `make debug` or a production one with `make run`. Production needs the `PORT` environment variable.
 
+The Jetstream ingestor can be started with `make ingestor`.
+
+### systemd
+
+Two systemd service files are found in the `dist` folder. They can be used to run both the server and the jetstream ingestor.
+
 [atproto]: https://atproto.com
 [uv]: https://docs.astral.sh/uv/
+[jetstream]: https://atproto.wiki/en/wiki/reference/networking/jetstream
diff --git a/pyproject.toml b/pyproject.toml
index 8657362..a391b99 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -2,7 +2,7 @@
 name = "ligo-at"
 version = "0.0.1"
 description = "Decentralized links page on top of AT Protocol"
-readme = "readme.md"
+readme = "README.md"
 requires-python = ">=3.13"
 dependencies = [
     "aiodns>=3.5.0",
-- 
2.51.2