www: drop --subject from "git send-email" instructions

[public-inbox.git] / README

diff --git a/README b/README
index f56d68d2307d284e5b17e5c4db59d3a2838d1767..364ef7e0fcee28ec22096ed2b3a919bfbddb8a6a 100644 (file)
--- a/README
+++ b/README
@@ -3,7 +3,7 @@ public-inbox - an "archives first" approach to mailing lists
 
 public-inbox implements the sharing of an email inbox via git to
 complement or replace traditional mailing lists.  Readers may
-read via NNTP, Atom feeds or HTML archives.
+read via NNTP, IMAP, Atom feeds or HTML archives.
 
 public-inbox spawned around three main ideas:
 
@@ -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
-  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.
@@ -22,8 +23,9 @@ to run their own instances with minimal overhead.
 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.
@@ -35,10 +37,10 @@ discussions if archives do not expose Message-ID and References
 headers.  List server admins are also burdened with delivery
 failures.
 
-public-inbox uses the "pull" model.  Casual readers may also
-follow the list via NNTP, Atom feed or HTML archives.
+public-inbox uses the "pull" model.  Casual readers may
+follow the list via NNTP, IMAP, 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
@@ -54,7 +56,7 @@ Features
 
 * stores email in git, readers may have a complete archive of the inbox
 
-* Atom feed and NNTP allows casual readers to follow via feed reader
+* Atom feed, IMAP, NNTP allows casual readers to follow via local tools
 
 * uses only well-documented and easy-to-implement data formats
 
@@ -62,7 +64,7 @@ Try it out now, see https://try.public-inbox.org/
 
 Requirements for reading:
 
-* any software capable of NNTP or following Atom feeds
+* any software capable of IMAP, NNTP or following Atom feeds
 
 Any basic web browser will do for the HTML archives.
 We primarily develop on w3m to maximize accessibility.
@@ -75,6 +77,9 @@ Requirements (participant)
   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)
@@ -85,9 +90,12 @@ See https://public-inbox.org/INSTALL
 Hacking
 -------
 
-Source code is available via git:
+AGPL source code is available via git:
 
-       git clone https://public-inbox.org/ public-inbox
+       git clone https://public-inbox.org/public-inbox.git
+       git clone https://repo.or.cz/public-inbox.git
+       torsocks git clone http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/public-inbox.git
+       torsocks git clone http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/public-inbox
 
 See below for contact info.
 
@@ -106,18 +114,24 @@ subscription.  This also makes it easier to rope in folks of
 tangentially related projects we depend on (e.g. git developers
 on git@vger.kernel.org).
 
-The archives are readable via NNTP or HTTP:
+The archives are readable via IMAP, NNTP or HTTP:
 
-       nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
+       nntps://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
+       imaps://news.public-inbox.org/inbox.comp.mail.public-inbox.meta.0
        https://public-inbox.org/meta/
 
-You may also clone all messages via git:
+AUTH=ANONYMOUS is supported for IMAP, but any username + password works
 
-       git clone --mirror https://public-inbox.org/meta/
+And as Tor hidden services:
 
-Or pass the same git repository URL for ssoma using the instructions at:
+       http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/
+       nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta
+       imap://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta.0
 
-       https://ssoma.public-inbox.org/README.html
+You may also clone all messages via git:
+
+       git clone --mirror https://public-inbox.org/meta/
+       torsocks git clone --mirror http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/
 
 Anti-Spam
 ---------
@@ -132,7 +146,7 @@ Content Filtering
 -----------------
 
 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.
 
@@ -143,7 +157,7 @@ aims to preserve the focus on content, and not presentation.
 Copyright
 ---------
 
-Copyright 2013-2016 all contributors <meta@public-inbox.org>
+Copyright 2013-2021 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