[james-mime4j] branch master updated: README Improve MIME4J README (#57)

[btellier]

This is an automated email from the ASF dual-hosted git repository.

btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-mime4j.git


The following commit(s) were added to refs/heads/master by this push:
     new 9f85357  README Improve MIME4J README (#57)
9f85357 is described below

commit 9f85357e480d8090125909c1973094b15a8719d7
Author: Benoit TELLIER <btell...@linagora.com>
AuthorDate: Mon Sep 20 16:09:58 2021 +0700

    README Improve MIME4J README (#57)
---
 README      | 26 ------------------
 README.adoc | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 90 insertions(+), 26 deletions(-)

diff --git a/README b/README
deleted file mode 100644
index 0f31c55..0000000
--- a/README
+++ /dev/null
@@ -1,26 +0,0 @@
-Cryptography Notice
--------------------
-
-   This distribution includes cryptographic software.  The country in 
-   which you currently reside may have restrictions on the import, 
-   possession, use, and/or re-export to another country, of 
-   encryption software.  BEFORE using any encryption software, please 
-   check your country's laws, regulations and policies concerning the
-   import, possession, or use, and re-export of encryption software, to 
-   see if this is permitted.  See <http://www.wassenaar.org/> for more
-   information.
-
-   The U.S. Government Department of Commerce, Bureau of Industry and
-   Security (BIS), has classified this software as Export Commodity 
-   Control Number (ECCN) 5D002.C.1, which includes information security
-   software using or performing cryptographic functions with asymmetric
-   algorithms.  The form and manner of this Apache Software Foundation
-   distribution makes it eligible for export under the License Exception
-   ENC Technology Software Unrestricted (TSU) exception (see the BIS 
-   Export Administration Regulations, Section 740.13) for both object 
-   code and source code.
-
-   The following provides more details on the included cryptographic
-   software:
-
-     Standard JRE functions allow encrypted storage
diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..1c94831
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,90 @@
+Apache James MIME4J
+===================
+
+image:https://img.shields.io/badge/Join%20us-Mailing%20lists-purple.svg[link="https://james.apache.org/mail.html";]
+link:https://gitter.im/apache/james-project[image:https://badges.gitter.im/apache/james-project.svg[Join
 the chat at link:https://gitter.im/apache/james-project]]
+image:https://img.shields.io/badge/CI-Jenkins-blue.svg[link="https://ci-builds.apache.org/job/james/job/ApacheJames-Mime4J/";]
+image:https://img.shields.io/badge/Documentation-green.svg[link="https://james.apache.org/mime4j/index.html";]
+image:https://img.shields.io/badge/Downloads-0.8.5-yellow.svg[link="https://james.apache.org/download.cgi#Apache_Mime4J";]
+image:https://img.shields.io/badge/Tickets-JIRA-blue.svg[link="https://issues.apache.org/jira/projects/MIME4J/issues";]
+image:https://img.shields.io/badge/License-ApacheV2-orange.svg[link="https://www.apache.org/licenses/";]
+image:https://img.shields.io/badge/Latests-news-red.svg[link="https://james.apache.org/index.html#posts";]
+
+image::james-logo.png[link="https://james.apache.org";]
+
+*Mime4j* can be used to parse e-mail message streams in plain
+link:https://datatracker.ietf.org/doc/html/rfc822[rfc822] and MIME format
+and to build a tree representation of an e-mail message.
+
+The parser uses a callback mechanism to report parsing events such as the 
start of
+an entity header, the start of a body. The parser has been designed to be 
extremely
+tolerant against messages violating the standards.
+
+Mime4j can also be used to build a tree representation of an e-mail message 
via the DOM API.
+
+== How to contribute?
+
+.Read more...
+[%collapsible]
+====
+James is a project that lives from the contributions of its community! Anyone 
can contribute!
+
+Read https://james.apache.org/index.html#third[how to contribute].
+
+We more than welcome *articles* and *blog posts* about James. Contact us by 
https://james.apache.org/mail.html[email]
+or on https://gitter.im/apache/james-project[Gitter] to share your experiences.
+
+*Documentation* is an easy way to get started, and more than wanted! Check out 
the 
https://issues.apache.org/jira/issues/?jql=project%20%3D%MIME4J%20AND%20resolution%20%3D%20Unresolved%20AND%20labels%20%3D%20documentation%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC[~documentation]
 label on JIRA.
+
+And to get started with *code contributions*, search out the
+https://issues.apache.org/jira/issues/?jql=project%20%3D%20MIME4J%20AND%20resolution%20%3D%20Unresolved%20AND%20labels%20%3D%20newbie%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC[~newbie],
+https://issues.apache.org/jira/issues/?jql=project%20%3D%20MIME4J%20AND%20resolution%20%3D%20Unresolved%20AND%20labels%20%3D%20easyfix%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC[~easyfix],
+https://issues.apache.org/jira/issues/?jql=project%20%3D%20MIME4J%20AND%20resolution%20%3D%20Unresolved%20AND%20labels%20%3D%20feature%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC[~feature]
 labels on JIRA.
+
+There is many other ways one can help us: packaging, communication, etc ...
+====
+
+== Maven dependencies
+
+.Read more...
+[%collapsible]
+====
+Add this maven dependency to import MIME4J core:
+
+....
+<dependency>
+    <groupId>org.apache.james</groupId>
+    <artifactId>apache-mime4j-core</artifactId>
+    <version>0.8.5</version>
+</dependency>
+....
+
+Add this maven dependency to import MIME4J dom:
+
+....
+<dependency>
+    <groupId>org.apache.james</groupId>
+    <artifactId>apache-mime4j-dom</artifactId>
+    <version>0.8.5</version>
+</dependency>
+....
+====
+
+== How to compile the project
+
+.Read more...
+[%collapsible]
+====
+We require link:https://maven.apache.org[maven] version 3.6.0 minimum to build 
the project.
+
+Simply run `mvn clean install` within this directory to compile the project.
+
+Useful options includes:
+
+- `-DskipTests` to skip the long to execute resource consuming test suite that 
requires a docker daemon.
+- `-T 4` to parallelize the build on several CPUs.
+====
+
+== How to use MIME4J
+
+We maintain a set of 
link:examples/src/main/java/org/apache/james/mime4j/samples[examples] detailing 
how one can use MIME4J.
\ No newline at end of file

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org
For additional commands, e-mail: server-dev-h...@james.apache.org