SLING-3297 - README
git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1553102 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/mail-archive/README.md b/mail-archive/README.md
new file mode 100644
index 0000000..9d716c7
--- /dev/null
+++ b/mail-archive/README.md
@@ -0,0 +1,25 @@
+Apache Sling mail archive server sample app
+==========================================
+
+This is a work in progress sample application for Sling, initially
+contributed by Igor Bogomolov who wrote it as part of an internship,
+and meant to create a useful mail archive server that also serves
+as a more complex Sling sample.
+
+To run this, install the dom, core and mbox bundles from the
+http://james.apache.org/mime4j/ project on a trunk Sling launchpad
+instance, and install the bundles provided by this module. Note the
+MIME4J-231 issue when building the Mime4J bundles.
+
+Then, start at http://localhost:8080/mailarchiveserver/import.mbox.html
+to import a few mbox files, you can find some at
+server/src/test/resources/test-files/mbox/
+
+http://localhost:8080/mailarchiveserver.html is the server's homepage.
+
+To import live mail from a mail server you need a Connector - the SLING-3297
+contribution does include one for Exchange, but we haven't included it
+in this sample so far.
+
+Stats (even more work in progress) are available at
+http://localhost:8080/content/mailarchiveserver/stats.html
