Add introduction.md

cfg/client.json5

@@ -33,7 +33,6 @@
   // Default EHLO to use.
   ehlo: "mimecast.net",
 
-
   // Default sender and recipients.
   mail: "[email protected]",
   rcpt: [

doc/cli.md

@@ -34,17 +34,17 @@ Server
      Path to configuration directory
 
     example:
-     java -jar robin.jar --server config/
+     java -jar robin.jar --server cfg/
 
 Common
 ------
 
 The Log4j2 XML filename can be configured via properties.json5 or a system property called `log4j2`.
 
     example:
-     java -jar robin.jar --server config/ -Dlog4j2=log4j2custom.xml
+     java -jar robin.jar --server cfg/ -Dlog4j2=log4j2custom.xml
 
 The properties.json5 filename can be configured via a system property called `properties`.
 
     example:
-     java -jar robin.jar --server config/ -Dproperties=properties-new.json5
+     java -jar robin.jar --server cfg/ -Dproperties=properties-new.json5

doc/introduction.md

@@ -0,0 +1,30 @@
+Introduction
+============
+Before you start the server or run the example clients you should start by checking the config files
+and make any required changes according to your environment.
+
+
+Robin client
+------------
+Is designed to use minimal config and as such it loads defaults from [client.json5](../cfg/client.json5).
+You may want to adjust the following values: mx, port, ehlo, main and rcpt.
+Additionaly you may want to configure your own routes for even more streamlined case config.
+
+- See ExampleSend.java for examples on how to craft JSON5 cases to send emails.
+  - Read [case.md](case.md), [magic.md](magic.md) and [mime.md](mime.md). 
+- See ExampleHttp.java for examples on how to craft JSON5 cases to do HTTP requests.
+  - Read [request.md](request.md). 
+- See ExampleProgramatic.java for examples on how to use it as a Java library.
+    - Read [client.md](client.md) and to extend its capabilities [plugin.md](plugin.md).
+- Read [cli.md](cli.md) for commandline usage.
+
+
+Robin server
+------------
+It might need some configuring as well in  [server.json5](../cfg/server.json5) in order to be able to load a keystore. One is provided in test resources.
+Additionaly you may want to update the email store path.
+
+- Read [cli.md](cli.md) for commandline usage.
+
+
+_Use it wisely!_

readme.md

@@ -48,6 +48,7 @@ This project makes use of sample password as needed for testing and demonstratio
 
 More...
 -------
+- [Introduction](doc/introduction.md)
 - [CLI usage](doc/cli.md)
 - [Client usage](doc/client.md)
 - [Server configuration](doc/server.md)