[pulsar-adapters] branch master updated: Add build instructions to README (#24)

[lh...@apache.org]

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

lhotari pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar-adapters.git


The following commit(s) were added to refs/heads/master by this push:
     new df8fc19  Add build instructions to README (#24)
df8fc19 is described below

commit df8fc1936af91aa52fe4ee268dcd8fb8a29b4d1b
Author: Enrico Olivelli <eo...@gmail.com>
AuthorDate: Sat Jun 26 14:07:25 2021 +0200

    Add build instructions to README (#24)
    
    Co-authored-by: Enrico Olivelli <eo...@apache.org>
---
 README.md | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index b819fd2..00fccc8 100644
--- a/README.md
+++ b/README.md
@@ -21,4 +21,26 @@
 
 # Apache Pulsar Adapters
 
-This repository is used for hosting all the adapters maintained and supported by Apache Pulsar PMC.
\ No newline at end of file
+This repository is used for hosting all the adapters maintained and supported by Apache Pulsar PMC.
+
+
+
+## Building
+
+In order to build this code you can simply use Maven
+
+mvn install
+
+In order to build this repository the linked Pulsar release must be released to Maven Central
+other wise you have to build it locally.
+
+For instance if this code depends on Pulsar 2.8.0 you have to build Pulsar 2.8.0 locally
+
+```
+git clone https://github.com/apache/pulsar
+git checkout v2.8.0
+mvn clean install -DskipTests
+```
+
+This is because this repository depends on test integration artifacts of the relative version on the main 
+Apache Pulsar codebase