doc: add technical/whyperl

[public-inbox.git] / README

diff --git a/README b/README
index 150dbeccd2f07f1c123ba5c4fcab0b1090ccbf9b..ae428bcfe11796657c97913dabdf45b5a2bc9fd2 100644 (file)
--- a/README
+++ b/README
@@ -14,7 +14,8 @@ public-inbox spawned around three main ideas:
   use of non-Free services or software.
 
 * Graphical user interfaces should not be required for text-based
   use of non-Free services or software.
 
 * Graphical user interfaces should not be required for text-based

-  communication.
+  communication.  Users may have broken graphics drivers, limited
+  eyesight, or be unable to afford modern hardware.

 
 public-inbox aims to be easy-to-deploy and manage; encouraging projects
 to run their own instances with minimal overhead.
 
 public-inbox aims to be easy-to-deploy and manage; encouraging projects
 to run their own instances with minimal overhead.


@@ -22,8 +23,9 @@ to run their own instances with minimal overhead.
 Implementation
 --------------
 
 Implementation
 --------------
 

-public-inbox stores mail in a git repository keyed by Message-ID
-as documented in: https://ssoma.public-inbox.org/ssoma_repository.txt
+public-inbox stores mail in git repositories as documented
+in https://public-inbox.org/public-inbox-v2-format.txt and
+https://public-inbox.org/public-inbox-v1-format.txt

 
 By storing (and optionally) exposing an inbox via git, it is
 fast and efficient to host and mirror public-inboxes.
 
 By storing (and optionally) exposing an inbox via git, it is
 fast and efficient to host and mirror public-inboxes.


@@ -35,10 +37,10 @@ discussions if archives do not expose Message-ID and References
 headers.  List server admins are also burdened with delivery
 failures.
 
 headers.  List server admins are also burdened with delivery
 failures.
 

-public-inbox uses the "pull" model.  Casual readers may also
+public-inbox uses the "pull" model.  Casual readers may

 follow the list via NNTP, Atom feed or HTML archives.
 
 follow the list via NNTP, Atom feed or HTML archives.
 

-If a reader loses interest, they simply stop syncing.
+If a reader loses interest, they simply stop following.

 
 Since we use git, mirrors are easy-to-setup, and lists are
 easy-to-relocate to different mail addresses without losing
 
 Since we use git, mirrors are easy-to-setup, and lists are
 easy-to-relocate to different mail addresses without losing


@@ -75,6 +77,9 @@ Requirements (participant)
   their mailers to reduce the impact of a public-inbox as a
   single point of failure.
 
   their mailers to reduce the impact of a public-inbox as a
   single point of failure.
 

+* The HTTP web interface exposes mboxrd files, and NNTP clients often
+  feature reply-by-email functionality
+

 * participants do not need to install public-inbox, only server admins
 
 Requirements (server)
 * participants do not need to install public-inbox, only server admins
 
 Requirements (server)


@@ -87,8 +92,8 @@ Hacking
 
 AGPL source code is available via git:
 
 
 AGPL source code is available via git:
 

-       git clone https://public-inbox.org/ public-inbox
-       git clone git://repo.or.cz/public-inbox
+       git clone https://public-inbox.org/public-inbox.git
+       git clone https://repo.or.cz/public-inbox.git

        torsocks git clone http://hjrcffqmbrq6wope.onion/public-inbox
 
 See below for contact info.
        torsocks git clone http://hjrcffqmbrq6wope.onion/public-inbox
 
 See below for contact info.


@@ -123,10 +128,6 @@ You may also clone all messages via git:
        git clone --mirror https://public-inbox.org/meta/
        torsocks git clone --mirror http://hjrcffqmbrq6wope.onion/meta/
 
        git clone --mirror https://public-inbox.org/meta/
        torsocks git clone --mirror http://hjrcffqmbrq6wope.onion/meta/
 

-Or pass the same git repository URL for ssoma using the instructions at:
-
-       https://ssoma.public-inbox.org/README.html
-

 Anti-Spam
 ---------
 
 Anti-Spam
 ---------
 


@@ -140,7 +141,7 @@ Content Filtering
 -----------------
 
 To discourage phishing, trackers, exploits and other nuisances,
 -----------------
 
 To discourage phishing, trackers, exploits and other nuisances,

-only plain-text emails are allowed and HTML is rejected.
+only plain-text emails are allowed and HTML is rejected by default.

 This improves accessibility, and saves bandwidth and storage
 as mail is archived forever.
 
 This improves accessibility, and saves bandwidth and storage
 as mail is archived forever.
 


@@ -151,7 +152,7 @@ aims to preserve the focus on content, and not presentation.
 Copyright
 ---------
 
 Copyright
 ---------
 

-Copyright 2013-2016 all contributors <meta@public-inbox.org>
+Copyright 2013-2020 all contributors <meta@public-inbox.org>

 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
 This program is free software: you can redistribute it and/or modify
 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
 This program is free software: you can redistribute it and/or modify