From b07ca37663545ace1dc4730d4a5abdf1e7dc0d9b Mon Sep 17 00:00:00 2001 From: blankie Date: Wed, 17 Jun 2026 05:16:34 +0000 Subject: [PATCH] readme: update project structure to reflect src layout --- README.md | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index c092eda..b38ae0e 100644 --- a/README.md +++ b/README.md @@ -215,21 +215,26 @@ For full feature docs, see the [tinyweb-forum README](https://codeberg.org/tinyw ## Project structure ``` -app.py — Entry point: boots Reticulum, starts HTTP gateway -gateway.py — HTTP-to-RNS bridge (local or remote dispatch) -handlers/ — Route dispatcher and request handlers - __init__.py — Dispatch logic + re-exports - _helpers.py — CSRF, FTS sanitizer, pagination, response builders - search.py — Search (BM25, hybrid, trusted/remote results) - pages.py — Add/edit/delete/bulk/bookmark handlers - subscriptions.py — Sync, sharing, API, subscription CRUD - customize.py — Settings form, about page - tags.py — Tag list and browse - data.py — Export, import, semantic reindex -db.py — SQLite database, FTS5, URL fetching, SSRF protection -templates.py — HTML template rendering and escaping -rns_client.py — Reticulum client for fetching remote site lists -themes/ — Saved HTML templates (e.g. kodama.html) +app.py — Entry point (shim, imports from tinyweb.app) +pyproject.toml — Package configuration (src layout) +src/tinyweb/ + __init__.py — Package marker + app.py — Boots Reticulum, starts HTTP gateway + db.py — SQLite database, FTS5, URL fetching, SSRF protection + gateway.py — HTTP-to-RNS bridge (local or remote dispatch) + templates.py — HTML template rendering and escaping + embeddings.py — Semantic search: ONNX, HNSW, reranking + rns_client.py — Reticulum client for fetching remote site lists + handlers/ + __init__.py — Dispatch logic + re-exports + _helpers.py — CSRF, FTS sanitizer, pagination, response builders + search.py — Search (BM25, hybrid, trusted/remote results) + pages.py — Add/edit/delete/bulk/bookmark handlers + subscriptions.py — Sync, sharing, API, subscription CRUD + customize.py — Settings form, about page + tags.py — Tag list and browse + data.py — Export, import, semantic reindex +themes/ — Saved HTML templates (e.g. default.html, junimo.html) ``` ## Security