diff --git a/Build-Variants.md b/Build-Variants.md new file mode 100644 index 0000000..8474e8d --- /dev/null +++ b/Build-Variants.md @@ -0,0 +1,24 @@ +# Jitpack repository (default) + +The library is typically consumed from jitpack.io with: + + dependencies { + implementation 'com.github.mik3y:usb-serial-for-android:2.x.y + } + +When pushing to github with jitpack enabled, +__*.aar__ and __*-sources.jar__ are automatically published by jitpack, +even if no `maven` or `maven-publish` gradle plugin is used. + +# Jar + +If you need a jar file (e.g. for cordova) run gradle task `createFullJarRelease` and use __full.jar__ + +# Local maven repository + +To use a local maven repository (e.g. for testing new library version) comment in + + //apply from: 'publishToMavenLocal.gradle' + +set correct version and run gradle task `publishToMavenLocal`. +This include file is not enabled by default, as it confuses jitpack