about summary refs log tree commit homepage
path: root/README
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2021-01-25 19:18:32 +0000
committerEric Wong <e@80x24.org>2021-01-25 19:33:54 +0000
commit098039f344655bcb940f7cb4b626517924753540 (patch)
tree74544ee3b3aca0152b15428e2dd52e6073c60fb1 /README
parent72d4cd2a056040c4a90b4f75a77317af26a20779 (diff)
downloadpublic-inbox-098039f344655bcb940f7cb4b626517924753540.tar.gz
I forgot to update these when releasing 1.6 :x
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 10 insertions, 6 deletions
diff --git a/README b/README
index e7a8bf84..5f8a1a68 100644
--- 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:
 
@@ -38,7 +38,7 @@ headers.  List server admins are also burdened with delivery
 failures.
 
 public-inbox uses the "pull" model.  Casual readers may
-follow the list via NNTP, Atom feed or HTML archives.
+follow the list via NNTP, IMAP, Atom feed or HTML archives.
 
 If a reader loses interest, they simply stop following.
 
@@ -56,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
 
@@ -64,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.
@@ -114,15 +114,19 @@ 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/
 
+AUTH=ANONYMOUS is supported for IMAP, but any username + password works
+
 And as Tor hidden services:
 
         http://hjrcffqmbrq6wope.onion/meta/
         nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
+        imap://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta.0
 
 You may also clone all messages via git: