docs: very basic README

Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: I88b30336df1c69fc805cb0b6a1239e776a6a6964
This commit is contained in:
raf 2026-03-16 18:23:11 +03:00
commit 6526d66636
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF

34
README.md Normal file
View file

@ -0,0 +1,34 @@
# Konservejo
Declarative, pipeline-based backup orchestrator for Forgejo with a focus on
backpressure tolerance, cryptographic verification, and fan-out concurrency.
## Name Origin
The name is derived from similar Esperanto morphology the same way the original
name does:
- `konservi` = to preserve
- `-ejo` = place
morphing into "preservation place" or "archive."
## Why?
Currently my work outside of Github is scattered on various Forgejo instances. I
do not wish to consolidate those into one, as I use those various instances with
different goals and intents but I _do_ want a safeguard that encapsulates all.
Thus, I've come up with a decision to create a proper solution that scratches my
itch. Here's how it is meant to look like:
<!--markdownlint-disable MD013 -->
```plaintext
[Forgejo A] ──┐
[Forgejo B] ──┼──> [Source Adapters] --> [Artifact Stream] --> [Dispatcher] --> [Sink A] --> [Verifier]
[Forgejo C] ──┘ │
├──> [Sink B] --> [Verifier]
└──> [Sink C] --> [Verifier]
```
<!--markdownlint-enable MD013-->