OverviewFilesCommitsIssuesDocsReleasesPeers

favela-bridge commits / 8c659d4

README: add the missing structural sections
Every factual claim in this file was verified against the source and left unchanged. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
8c659d417eb969df00ac3ff8fdb1e0f34aa2bc5e
by plankatron <fleeky@gmail.com> · 2026-09-10T15:29:32.000Z

Changed files (1) +13 -0

README.md +13 -0
……@@ -10,6 +10,15 @@ Projects a node's own favela records onto the networks its identity has turned o
1010 FAVELA_BSKY_SOCKET hyper-proto-peer's control socket — required to publish
1111 FAVELA_BRIDGE_INTERVAL seconds between cycles when watching (default 15)
1212
13## Install
14
15```sh
16pgh app install favela-bridge
17```
18
19Needs a running `favela-peer` (read) and, to publish, a running `hyper-proto-peer`
20(`FAVELA_BSKY_SOCKET`). With no `--send` it plans and reports and writes nothing.
21
1322## Why it is its own component
1423
1524favela-peer must not know what atproto is — `favela-peer/test/boundary.test.js` enforces it, from
……@@ -41,3 +50,7 @@ A failure to read either is OFF. Unknown consent is not consent.
4150 text and say so.
4251- **blobs.** hpp exposes `upload-blob`; nothing calls it. A post with a picture sends its text and
4352 reports the picture lost.
53
54## License
55
56Not yet declared.