]> Sergey Matveev's repositories - public-inbox.git/blobdiff - README
update copyright headers and email addresses
[public-inbox.git] / README
diff --git a/README b/README
index f12c1cba38c5e109a5d29e01a10194567013c03f..89e8521fa38463ae4894a839e3ce1194ea61457f 100644 (file)
--- a/README
+++ b/README
@@ -1,36 +1,25 @@
 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 Atom feeds and HTML archives.
 
 public-inbox spawned around three main ideas:
 
 * Publically accessible and archived communication is essential to
   Free and Open Source development.
-
 * Contributing to Free and Open Source projects should not require the
   use of non-Free/non-Open Source services or software.
-
 * Graphical user interfaces should not be required for text-based
   communication.
 
 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
-
-
 Implementation
 --------------
-
 public-inbox uses ssoma[1], Some Sort Of Mail Archiver which implements
 no policy of its own.  By exposing an inbox via git, readers may follow
 the inbox without subscribing via SMTP and have easy access to old
@@ -55,7 +44,17 @@ Casual readers may also follow the list via Atom feed or web 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/README
+[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)
 -------------------------------------
@@ -65,19 +64,19 @@ Any basic web browser will do for the HTML archives.
 
 Requirements (participant)
 --------------------------
-* ssoma - http://ssoma.public-inbox.org/INSTALL
+* ssoma - http://ssoma.public-inbox.org/
 * any MUA which may send text-only emails ("git send-email" works!)
 * participants do not need to install public-inbox, only server admins
 
 Requirements (server)
 ---------------------
-See INSTALL
+See http://public-inbox.org/INSTALL
 
 Hacking
 -------
 Source code is available via git:
 
-       git clone git://bogomips.org/public-inbox
+       git clone git://80x24.org/public-inbox
 
 See below for contact info.
 
@@ -95,9 +94,9 @@ 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).
 
-You can subscribe via ssoma(1), LISTNAME is a name of your choosing:
+You may subscribe via ssoma(1), LISTNAME is a name of your choosing:
 
-    URL=git://git.public-inbox.org/public-inbox
+    URL=git://public-inbox.org/meta
     LISTNAME=public-inbox
 
     # to initialize a maildir (this may be a new or existing maildir,
@@ -114,8 +113,10 @@ You can subscribe via ssoma(1), LISTNAME is a name of your choosing:
     # your MUA may modify and delete messages from the maildir or mbox,
     # this does not affect ssoma functionality at all
 
-    # to sync all your ssoma subscriptions
-    ssoma sync
+    # to sync all your ssoma subscriptions via cronjob
+    ssoma sync --cron
+
+HTML inbox archives are available: http://public-inbox.org/meta/
 
 Anti-Spam
 ---------
@@ -143,7 +144,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