]> Sergey Matveev's repositories - public-inbox.git/blobdiff - README
README: add OpenSSL exception
[public-inbox.git] / README
diff --git a/README b/README
index 646caa9f265d89897f5f0254fb39ada2491041b1..8ae307a04332ee14f246d124fe92e8928c267fd7 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,11 @@
 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.
+complement or replace traditional mailing lists.  Readers may
+subscribe to a mailing list using ssoma[1] (a git-wrapper) to
+import email from a git repository into an IMAP folder, Maildir,
+or mbox.  Readers may also read via NNTP, Atom feeds and HTML
+archives.
 
 public-inbox spawned around three main ideas:
 
@@ -15,16 +19,6 @@ public-inbox spawned around three main ideas:
 public-inbox aims to be easy-to-deploy and manage; encouraging projects
 to run their own instances with minimal overhead.
 
-Features
---------
-* anybody may participate via plain-text email
-* stores email in git, readers have a complete archive of the inbox
-* Atom feed allows casual readers to follow via feed reader
-* Mail user-agent (MUA) users may use Maildir, mbox(5) and/or IMAP locally
-* uses only well-documented and easy-to-implement data formats
-
-Try it out now, see http://try.public-inbox.org/
-
 Implementation
 --------------
 public-inbox uses ssoma[1], Some Sort Of Mail Archiver which implements
@@ -46,13 +40,24 @@ addresses without losing/splitting archives.  Dedicated readers only
 need to install ssoma, a command-line tool[1] currently implemented in
 Perl.
 
-Casual readers may also follow the list via Atom feed or web archives.
+Casual readers may also follow the list via NNTP, Atom feed or
+HTML archives.
 
 _Anybody_ may also setup a delivery-only mailing list server to replay
 a public-inbox git archive to subscribers via SMTP.
 
 [1] http://ssoma.public-inbox.org/
 
+Features
+--------
+* anybody may participate via plain-text email
+* stores email in git, readers have a complete archive of the inbox
+* Atom feed allows casual readers to follow via feed reader
+* Mail user-agent (MUA) users may use Maildir, mbox(5) and/or IMAP locally
+* uses only well-documented and easy-to-implement data formats
+
+Try it out now, see http://try.public-inbox.org/
+
 Requirements (Atom, read-only client)
 -------------------------------------
 * any feed reader capable of following Atom feeds
@@ -67,7 +72,7 @@ Requirements (participant)
 
 Requirements (server)
 ---------------------
-See http://public-inbox.org/INSTALL.html
+See http://public-inbox.org/INSTALL
 
 Hacking
 -------
@@ -114,6 +119,8 @@ You may subscribe via ssoma(1), LISTNAME is a name of your choosing:
     ssoma sync --cron
 
 HTML inbox archives are available: http://public-inbox.org/meta/
+The archives are also readable via NNTP:
+       nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
 
 Anti-Spam
 ---------
@@ -141,7 +148,7 @@ aims to preserve the focus on content, and not presentation.
 
 Copyright
 ---------
-Copyright 2013, Eric Wong <normalperson@yhbt.net> and all contributors.
+Copyright 2013-2015 all contributors <meta@public-inbox.org>
 License: AGPLv3 or later <http://www.gnu.org/licenses/agpl-3.0.txt>
 
 This program is free software: you can redistribute it and/or modify
@@ -156,3 +163,14 @@ GNU Affero General Public License for more details.
 
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Additional permission under GNU GPL version 3 section 7:
+
+    If you modify this program, or any covered work, by linking or
+    combining it with the OpenSSL project's OpenSSL library (or a
+    modified version of that library), containing parts covered by the
+    terms of the OpenSSL or SSLeay licenses, the copyright holder(s)
+    grants you additional permission to convey the resulting work.
+    Corresponding Source for a non-source form of such a combination
+    shall include the source code for the parts of OpenSSL used as well
+    as that of the covered work.