From 37342a5e287e2a0f8fbf3847053b6fb2b0b52a03 Mon Sep 17 00:00:00 2001 From: Dirk Schnelle-Walka <dirk.schnelle@jvoicexml.org> Date: Wed, 23 Feb 2022 11:53:51 +0100 Subject: [PATCH] Added some more descriptions to the readme how it can be included. --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index 2939a7c..4f065e9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,43 @@ # RTP Library for Java jlibrtp aims to create a library that makes it easy to support RTP (RFC 3550,3551) in Java applications. SRTP (RFC 3771) has been delayed in favor of RFC 4585. + +In order to increase compatibility, this library is compiled with JDK1.8. + +## Include from from Maven + +Configure maven to use Central from your Project Object Model (POM) file.You may do so by +adding the following to your pom.xml: + + <repositories> + <repository> + <id>central</id> + <name>Maven Central</name> + <layout>default</layout> + <url>https://repo1.maven.org/maven2</url> + <snapshots> + <enabled>false</enabled> + </snapshots> + </repository> + </repositories> + +Add jlibrtp as a dependecy to your pom.xml + + <dependency> + <groupId>org.jvoicexml</groupId> + <artifactId>org.jlibrtp</artifactId> + <version>0.2</version> + <type>module</type> + </dependency> + +## Include from Gradle + +Add the Maven Central repository to your build.gradle + + repositories { + mavenCentral() + } + +Add jlibrtp as a an implementation dependency to your build.gradle + + implementation 'org.jvoicexml:org.librtp:0.2'