From a702dd69e6483c3c99ee7e104f92a5cc3dc63c2f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christopher=20M=C3=BChl?= Date: Tue, 17 Feb 2026 22:49:55 +0100 Subject: [PATCH] feat: initial pitch --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7153543 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# Solid Gate + +> Your Solid pod, with an API surface you define. + +## What is this? + +[Solid](https://solidproject.org/) is great for storing your personal RDF data in a pod you control. The problem: every app that wants to read your data needs to speak LDP, understand your specific vocabularies, and parse RDF. Almost none do. + +Solid Gate is the adapter layer. Define a mapping template once, and your pod data is exposed as whatever format a consuming app actually wants — RSS, iCal, JSON, a REST endpoint, anything. + +Think of it as [SPARQL-Anything](https://sparql-anything.cc/) in reverse: SPARQL-Anything lets you query arbitrary formats *as if* they were RDF. Solid Gate lets you serve your RDF *as if* it were any arbitrary format. + +## How it works + +1. **Authenticate** — grant Solid Gate read access to your pod via Solid OIDC +2. **Deploy a template** — pick one from the library or write your own +3. **Get a stable URL** — your transformed data is cached and served at a permanent endpoint +4. **Stays fresh** — [Solid Notifications](https://solid.github.io/notifications/protocol) trigger recomputation when your pod data changes; stale cache is served in between + +``` +Your Solid Pod → Solid Gate → stable URL (RSS / iCal / JSON / ...) + ↑ + mapping template + (yours or community) +``` + +## Example use cases + +- **Bookmarks → RSS** — publish a "what I'm reading" feed from your pod bookmarks +- **Events → iCal** — expose your RDF event data to any calendar app +- **Contacts → vCard** — bridge your pod contacts to legacy address book apps +- **Any RDF → REST API** — give legacy apps a familiar interface to your pod data + +## Deployment + +### Self-hosted + +Coming soon. + +### Hosted + +Coming soon. Authenticate with your Solid identity, deploy a template, done. + +## Status + +Early design phase. Part of the [Aleph Garden](https://aph.gdn) personal semantic web project. + +## Related + +- [Solid Project](https://solidproject.org/) +- [SPARQL-Anything](https://sparql-anything.cc/) — the spiritual mirror of this project