Skip to content

Commit f78d5e3

Browse files
Publish package to jitpack.io (#6)
* Update readme with jitpack * Disable detekt
1 parent d25f717 commit f78d5e3

File tree

4 files changed

+51
-6
lines changed

4 files changed

+51
-6
lines changed

.idea/jarRepositories.xml

Lines changed: 5 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Beckon
1+
# Beckon [![](https://jitpack.io/v/technocreatives/beckon-android.svg)](https://jitpack.io/#technocreatives/beckon-android)
22

33
A safe, correct and pleasant Bluetooth Low Energy (BLE) library for Android with functional data types and RxJava interface.
44

@@ -12,9 +12,27 @@ By using functional programming approach and Rxjava interface, this library (wil
1212
- The best error handling ever which is backed by [Arrow](https://arrow-kt.io/).
1313
- Support all BLE operations (read, write, notifications, bond). Thanks to [NordicSemiconductor/Android-BLE-Library](https://github.com/NordicSemiconductor/Android-BLE-Library)!
1414

15-
## Install
15+
## Setup <a name = "setup"></a>
16+
17+
You can get `Beckon` by using [Jitpack](https://jitpack.io/#technocreatives/beckon).
18+
19+
```Gradle
20+
repositories {
21+
jcenter()
22+
maven { url 'https://jitpack.io' }
23+
}
24+
25+
implementation "com.github.technocreatives:beckon:$beckon"
26+
```
27+
28+
## Compatibility <a name = "compatibility"></a>
29+
30+
Supports RxJava2 and Arrow version `0.13.2`.
31+
32+
## Contributing <a name = "contributing"></a>
33+
34+
Any bug reports, feature requests, questions and pull requests are very welcome.
1635

17-
You have to use Beckon as a submodule or subtree.
1836

1937
## Usage
2038

beckon/build.gradle

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ apply plugin: 'kotlin-android'
33
apply plugin: 'kotlin-kapt'
44
apply plugin: 'de.mannodermaus.android-junit5'
55

6+
67
android {
78
compileSdkVersion 30
89

@@ -128,3 +129,19 @@ task ktlintFormat(type: JavaExec, group: "formatting") {
128129
main = "com.pinterest.ktlint.Main"
129130
args "-F", "src/**/*.kt"
130131
}
132+
133+
afterEvaluate {
134+
publishing {
135+
publications {
136+
// Creates a Maven publication called "release".
137+
release(MavenPublication) {
138+
// Applies the component for the release build variant.
139+
from components.release
140+
// You can then customize attributes of the publication as shown below.
141+
groupId = 'com.technocreatives'
142+
artifactId = 'beckon'
143+
version = '0.1.0'
144+
}
145+
}
146+
}
147+
}

build.gradle

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ buildscript {
2525
ext.spek_version = '2.0.7'
2626

2727
repositories {
28+
mavenLocal()
2829
google()
2930
mavenCentral()
3031
}
@@ -37,16 +38,19 @@ buildscript {
3738

3839
plugins {
3940
id "io.gitlab.arturbosch.detekt" version "1.17.1"
41+
id 'maven-publish'
4042
}
4143

42-
allprojects {
43-
apply from: "$rootDir/detekt.gradle"
44-
}
44+
45+
//allprojects {
46+
// apply from: "$rootDir/detekt.gradle"
47+
//}
4548

4649
tasks.detekt.jvmTarget = "1.8"
4750

4851
allprojects {
4952
repositories {
53+
mavenLocal()
5054
google()
5155
maven { url 'https://jitpack.io' }
5256
mavenCentral()
@@ -56,3 +60,4 @@ allprojects {
5660
task clean(type: Delete) {
5761
delete rootProject.buildDir
5862
}
63+

0 commit comments

Comments
 (0)