[sling-org-apache-sling-distribution-journal-it] branch master updated: SLING-8346 - Import Journal based Sling Content Distribution source code

[tmaret]

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

tmaret pushed a commit to branch master
in repository 
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-distribution-journal-it.git


The following commit(s) were added to refs/heads/master by this push:
     new 908d97b  SLING-8346 - Import Journal based Sling Content Distribution 
source code
908d97b is described below

commit 908d97b07d95feb5aa41fc60677c138ecf69230f
Author: tmaret <tma...@adobe.com>
AuthorDate: Wed Apr 17 14:16:41 2019 +0200

    SLING-8346 - Import Journal based Sling Content Distribution source code
    
    * update the README description of the module
---
 README.md                  | 15 +++++----------
 README.md => docs/setup.md |  9 +++------
 2 files changed, 8 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 898c182..3e367c3 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,8 @@
-org.apache.sling.distribution.journal.it
-==========================================
+[<img 
src="https://sling.apache.org/res/logos/sling.png"/>](https://sling.apache.org)
 
-Toxiproxy
----------
+# Apache Sling Journal based Content Distribution - ITs
 
-For some of the tests a local [toxiproxy 
installation](https://github.com/Shopify/toxiproxy#1-installing-toxiproxy) is 
needed.
-
-Unfortunately the docker version of toxiproxy does not work correctly on mac. 
It would need --net=host which does not work on mac as docker is run in a vm. 
So currently you need to install toxiproxy using brew manually and start it 
before the tests.
-
-If toxiproxy is not present the respective tests will be skipped with a 
message that toxiproxy server is missing.
-Because of a bug in pax exam the tests simply succeeed. So be aware that they 
might not check anything.
+This module is part of the [Apache Sling](https://sling.apache.org) project.
 
+This module contains integration tests for the Apache Sling Journal based 
Content Distribution modules.
+Please refer to the [setup](docs/setup.md) document to run the tests.
\ No newline at end of file
diff --git a/README.md b/docs/setup.md
similarity index 70%
copy from README.md
copy to docs/setup.md
index 898c182..c1ca3ae 100644
--- a/README.md
+++ b/docs/setup.md
@@ -1,13 +1,10 @@
-org.apache.sling.distribution.journal.it
-==========================================
+# Setup
 
-Toxiproxy
----------
+## Toxiproxy
 
 For some of the tests a local [toxiproxy 
installation](https://github.com/Shopify/toxiproxy#1-installing-toxiproxy) is 
needed.
 
 Unfortunately the docker version of toxiproxy does not work correctly on mac. 
It would need --net=host which does not work on mac as docker is run in a vm. 
So currently you need to install toxiproxy using brew manually and start it 
before the tests.
 
 If toxiproxy is not present the respective tests will be skipped with a 
message that toxiproxy server is missing.
-Because of a bug in pax exam the tests simply succeeed. So be aware that they 
might not check anything.
-
+Because of a bug in pax exam the tests simply succeed. So be aware that they 
might not check anything.