X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=README;h=d5ff11824b3a7e857bf5502e45cfedbb17b08fae;hb=43c0f38b8dc27254deb10204cf97d7af7e49d368;hp=2e403445e16b70561157a52de4256818f207ce3a;hpb=96a9baea24d8df9507b497ae930c42143174be66;p=public-inbox.git diff --git a/README b/README index 2e403445..d5ff1182 100644 --- a/README +++ b/README @@ -1,7 +1,10 @@ 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: @@ -15,14 +18,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 - Implementation -------------- public-inbox uses ssoma[1], Some Sort Of Mail Archiver which implements @@ -51,6 +46,16 @@ 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 @@ -65,7 +70,7 @@ Requirements (participant) Requirements (server) --------------------- -See http://public-inbox.org/INSTALL.html +See http://public-inbox.org/INSTALL Hacking ------- @@ -111,6 +116,8 @@ You may subscribe via ssoma(1), LISTNAME is a name of your choosing: # to sync all your ssoma subscriptions via cronjob ssoma sync --cron +HTML inbox archives are available: http://public-inbox.org/meta/ + Anti-Spam --------- The maintainer of public-inbox has found SpamAssassin a good tool for @@ -137,7 +144,7 @@ aims to preserve the focus on content, and not presentation. Copyright --------- -Copyright 2013, Eric Wong and all contributors. +Copyright 2013-2015, all contributors License: AGPLv3 or later This program is free software: you can redistribute it and/or modify