~ivilata/gwit-docs

3a54dc402c4fe15b5b7687fc1d789fa5bf23af35 — Ivan Vilata-i-Balaguer 9 months ago 185a2d5 master
Add list introducing features and usage.

To have a quick glimpse on how gwit may be used.
1 files changed, 11 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +11 -0
@@ 10,6 10,17 @@ Drawing inspiration from an article by Solderpunk (creator of the Gemini protoco
  [Web version](https://portal.mozz.us/gemini/gemini.circumlunar.space/~solderpunk/gemlog/low-budget-p2p-content-distribution-with-git.gmi "Low budget P2P content distribution with git (Gemini Portal)")
- [Git](https://git-scm.com/)

Features and usage:

- **Fit for lightweight sites:** personal blogs, books and documentation, reference works (like Wikipedia), and other text-centric, static but frequently updated sites.
- **Obstacle-less site creation:** no need to pay for a domain, certificate or server, just create a new PGP key for the site repo.
- **Opportunistic hosting:** make any gwit site available online by hosting its repo on Git forges or dumb HTTP servers (one or many, all at once).
- **Content replication and availability:** readers clone the whole site (with history), clones can be re-published and used safely by others, forever.
- **Enhance existing Web or Gemini sites:** make the static site also available from arbitrary locations via gwit, and accessible in the future. Plays well with static site generators.
- **Offline- and privacy-friendly:** cloned sites are browsed locally, no network needed.
- **Poor connectivity scenarios:** sites can be cloned or updated from offline media (sneakernet, Kiwix).
- **Collaborative content creation:** enabled by Git itself (with one per-site curator).

To publish a Git repo as a gwit site, just create a dedicated PGP key to identify the site in gwit URIs, tell Git to sign repo commits with that key, and publish the repo in any number of public locations. No specific software is needed. To make an existing Web/Gemini static site gwit-compatible, add a simple INI file to its repo.

Visiting a site with a gwit client program creates a full-history clone that may be shared online or offline, and preserved for long-time access: it's like a replicated "wayback machine", without archive trust issues or ad hoc crawling. The client may provide local, private browsing, search and content update notifications regardless of poor connectivity or censorship.