From 8ad654e037e5f4562b59b17c5568c43fa7ef37e0 Mon Sep 17 00:00:00 2001
From: CezarLeahu <35226487+CezarLeahu@users.noreply.github.com>
Date: Wed, 22 May 2019 11:49:35 +0300
Subject: [PATCH] ATS-400 : Update Readme files (#29)

---
 README.md                           | 68 +++++++++++++++++++++--------
 alfresco-transformer-base/README.md |  7 +--
 2 files changed, 53 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index a619236b..4b129d7c 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,61 @@
-# Project that generates Docker images to perform ACS transformations
+## Alfresco Transform Core
+[![Build Status](https://travis-ci.com/Alfresco/alfresco-transform-core.svg?branch=master)](https://travis-ci.com/Alfresco/alfresco-transform-core)
 
-## Sub-projects
+Contains the common transformer (T-Engine) code, plus a few actual implementations.
 
-* `alfresco-transformer-base` - contains code that is common to all the transformers. This includes
-  the streaming of content to and from the docker images. See the sub-project's
-  [README](https://git.alfresco.com/Repository/alfresco-docker-transformers/tree/master/alfresco-transformer-base).
-* Each `alfresco-docker-<name>` - contains two sub-projects. One builds an executable jar to communicate with the
-  Alfresco repository and another to create a Docker image that includes the jar and any required
-  executables.
+### Sub-projects
 
-## Building and testing
+* `alfresco-transformer-base` - library packaged as a jar file which contains code that is common
+ to all the transformers; see the sub-project's
+  [README](https://github.com/Alfresco/alfresco-transform-core/tree/master/alfresco-transformer-base)
+* `alfresco-docker-<name>` - multiple T-Engines; each one of them builds both a SpringBoot fat jar
+ and a Docker image
+
+
+### Building and testing
 
 The project can be built by running the Maven command:
+```bash
+mvn clean install -Plocal
+```
+> The `local` Maven profile builds local Docker images for each T-Engine.
 
-~~~
-mvn clean install
-~~~
+### Artifacts
 
-The build plan in Bamboo is PLAT-TRANS
+#### Maven
+The artifacts can be obtained by:
+* downloading from [Alfresco repository](https://artifacts.alfresco.com/nexus/content/groups/public)
+* getting as Maven dependency by adding the dependency to your pom file:
+```xml
+<dependency>
+    <groupId>org.alfresco</groupId>
+    <artifactId>alfresco-transformer-base</artifactId>
+    <version>version</version>
+</dependency>
+```
+and Alfresco Maven repository:
+```xml
+<repository>
+  <id>alfresco-maven-repo</id>
+  <url>https://artifacts.alfresco.com/nexus/content/groups/public</url>
+</repository>
+```
 
-## Contributing guide
+#### Docker
+The core T-Engine images are available on Docker Hub:
+* [alfresco/alfresco-imagemagick](https://hub.docker.com/r/alfresco/alfresco-imagemagick)
+* [alfresco/alfresco-pdf-renderer](https://hub.docker.com/r/alfresco/alfresco-pdf-renderer)
+* [alfresco/alfresco-libreoffice](https://hub.docker.com/r/alfresco/alfresco-libreoffice)
+* [alfresco/alfresco-tika](https://hub.docker.com/r/alfresco/alfresco-tika)
 
-Please use [this guide](https://github.com/Alfresco/alfresco-jodconverter/blob/master/CONTRIBUTING.md) to make a
-contribution to the project.
-
-## Release Process
+### Release Process
 
 For a complete walk-through check out the
 [build-and-release.MD](https://github.com/Alfresco/alfresco-transform-core/tree/master/docs/build-and-release.md)
-under the `docs` folder.
\ No newline at end of file
+under the `docs` folder.
+
+
+### Contributing guide
+
+Please use [this guide](https://github.com/Alfresco/alfresco-repository/blob/master/CONTRIBUTING.md)
+to make a contribution to the project.
diff --git a/alfresco-transformer-base/README.md b/alfresco-transformer-base/README.md
index 12165544..474ae0c3 100644
--- a/alfresco-transformer-base/README.md
+++ b/alfresco-transformer-base/README.md
@@ -221,9 +221,10 @@ and the Alfresco Maven repository:
 </repository>
 ~~~
 
-The build plan in Bamboo is PLAT-TB
+The build plan is available in [TravisCI](https://travis-ci.com/Alfresco/alfresco-transform-core).
 
 ## Contributing guide
 
-Please use [this guide](https://github.com/Alfresco/alfresco-jodconverter/blob/master/CONTRIBUTING.md) to make a
-contribution to the project.
+Please use [this guide](https://github.com/Alfresco/alfresco-repository/blob/master/CONTRIBUTING.md)
+to make a contribution to the project.
+