]> Sergey Matveev's repositories - public-inbox.git/blobdiff - README
nntp: inline CRLF in all response lines
[public-inbox.git] / README
diff --git a/README b/README
index 2412e40f87596a8f06ab669219416a7287449585..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
 
 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:
 
 
 public-inbox spawned around three main ideas:
 
@@ -15,7 +15,7 @@ public-inbox spawned around three main ideas:
 
 * Graphical user interfaces should not be required for text-based
   communication.  Users may have broken graphics drivers, limited
 
 * Graphical user interfaces should not be required for text-based
   communication.  Users may have broken graphics drivers, limited
-  eyesight, or unable to afford modern hardware.
+  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.
@@ -38,7 +38,7 @@ headers.  List server admins are also burdened with delivery
 failures.
 
 public-inbox uses the "pull" model.  Casual readers may
 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.
 
 
 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
 
 
 * 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
 
 
 * 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:
 
 
 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.
 
 Any basic web browser will do for the HTML archives.
 We primarily develop on w3m to maximize accessibility.
@@ -94,7 +94,8 @@ AGPL source code is available via git:
 
        git clone https://public-inbox.org/public-inbox.git
        git clone https://repo.or.cz/public-inbox.git
 
        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
+       torsocks git clone http://7fh6tueqddpjyxjmgtdiueylzoqt6pt7hec3pukyptlmohoowvhde4yd.onion/public-inbox.git
+       torsocks git clone http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/public-inbox
 
 See below for contact info.
 
 
 See below for contact info.
 
@@ -113,20 +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).
 
 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/
 
        https://public-inbox.org/meta/
 
+AUTH=ANONYMOUS is supported for IMAP, but any username + password works
+
 And as Tor hidden services:
 
 And as Tor hidden services:
 
-       http://hjrcffqmbrq6wope.onion/meta/
-       nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
+       http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/
+       nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta
+       imap://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta.0
 
 You may also clone all messages via git:
 
        git clone --mirror https://public-inbox.org/meta/
 
 You may also clone all messages via git:
 
        git clone --mirror https://public-inbox.org/meta/
-       torsocks git clone --mirror http://hjrcffqmbrq6wope.onion/meta/
+       torsocks git clone --mirror http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/
 
 Anti-Spam
 ---------
 
 Anti-Spam
 ---------
@@ -152,7 +157,7 @@ aims to preserve the focus on content, and not presentation.
 Copyright
 ---------
 
 Copyright
 ---------
 
-Copyright 2013-2020 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
 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