summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBrettyWhite <geekman3454@protonmail.com>2019-03-12 10:59:08 -0400
committerBrettyWhite <geekman3454@protonmail.com>2019-03-12 10:59:08 -0400
commit6648ffc4e6937ca227a10d5765102112c12575ff (patch)
treec51d79cba5c6d6411494d6070cfe29d7c060dbde /README.md
parented59f1ff4f0a392105b59aee66a8fbe8926177b5 (diff)
downloadsdl_android-6648ffc4e6937ca227a10d5765102112c12575ff.tar.gz
add licenses and break up readme's
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 38 insertions, 1 deletions
diff --git a/README.md b/README.md
index b5dad034e..5093a607d 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,8 @@ SmartDeviceLink (SDL) is a standard set of protocols and messages that connect a
* The [Core](https://github.com/smartdevicelink/sdl_core) component is the software which Vehicle Manufacturers (OEMs) implement in their vehicle head units. Integrating this component into their head unit and HMI based on a set of guidelines and templates enables access to various smartphone applications.
* The optional [SDL Server](https://github.com/smartdevicelink/sdl_server) can be used by Vehicle OEMs to update application policies and gather usage information for connected applications.
* The [iOS](https://github.com/smartdevicelink/sdl_ios) and [Android](https://github.com/smartdevicelink/sdl_android) libraries are implemented by app developers into their applications to enable command and control via the connected head unit.
-
+ * The [Embedded]() and [Cloud]() libraries, written in Java, are implemented by app developers into their applications to enable command and control to a connected head unit.
+
Pull Requests Welcome!
To understand if a contribution should be entered as an Android Pull Request (or issue), or an SDL Evolution Proposal, please reference [this document](https://github.com/smartdevicelink/sdl_evolution/blob/master/proposals_versus_issues.md).
@@ -56,4 +57,40 @@ Developers using Proguard to shrink and obfuscate their code should be sure to i
-keep class com.livio.** { *; }
# Video streaming apps must add the following line
-keep class ** extends com.smartdevicelink.streaming.video.SdlRemoteDisplay { *; }
+```
+
+## SmartDeviceLink Java
+
+### JavaSE
+
+The JavaSE project is meant to allow SDL compatibility for embedded applications.
+
+#### Dependency Managers
+
+To compile with the latest release of SDL JavaSE, include the following in your app's `build.gradle` file,
+
+```
+repositories {
+ jcenter()
+}
+dependencies {
+ implementation 'com.smartdevicelink:sdl_java_se:4.+'
+}
+```
+
+### JavaEE
+
+The JavaEE project is meant to allow SDL compatibility for web applications.
+
+#### Dependency Managers
+
+To compile with the latest release of SDL JavaEE, include the following in your app's `build.gradle` file,
+
+```
+repositories {
+ jcenter()
+}
+dependencies {
+ implementation 'com.smartdevicelink:sdl_java_ee:4.+'
+}
``` \ No newline at end of file