Skip to content

Commit

Permalink
Publish package to jitpack.io (#6)
Browse files Browse the repository at this point in the history
* Update readme with jitpack

* Disable detekt
  • Loading branch information
lenguyenthanh authored Jun 11, 2021
1 parent d25f717 commit f78d5e3
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 6 deletions.
5 changes: 5 additions & 0 deletions .idea/jarRepositories.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Beckon
# Beckon [![](https://jitpack.io/v/technocreatives/beckon-android.svg)](https://jitpack.io/#technocreatives/beckon-android)

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

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

## Install
## Setup <a name = "setup"></a>

You can get `Beckon` by using [Jitpack](https://jitpack.io/#technocreatives/beckon).

```Gradle
repositories {
jcenter()
maven { url 'https://jitpack.io' }
}
implementation "com.github.technocreatives:beckon:$beckon"
```

## Compatibility <a name = "compatibility"></a>

Supports RxJava2 and Arrow version `0.13.2`.

## Contributing <a name = "contributing"></a>

Any bug reports, feature requests, questions and pull requests are very welcome.

You have to use Beckon as a submodule or subtree.

## Usage

Expand Down
17 changes: 17 additions & 0 deletions beckon/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ apply plugin: 'kotlin-android'
apply plugin: 'kotlin-kapt'
apply plugin: 'de.mannodermaus.android-junit5'


android {
compileSdkVersion 30

Expand Down Expand Up @@ -128,3 +129,19 @@ task ktlintFormat(type: JavaExec, group: "formatting") {
main = "com.pinterest.ktlint.Main"
args "-F", "src/**/*.kt"
}

afterEvaluate {
publishing {
publications {
// Creates a Maven publication called "release".
release(MavenPublication) {
// Applies the component for the release build variant.
from components.release
// You can then customize attributes of the publication as shown below.
groupId = 'com.technocreatives'
artifactId = 'beckon'
version = '0.1.0'
}
}
}
}
11 changes: 8 additions & 3 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ buildscript {
ext.spek_version = '2.0.7'

repositories {
mavenLocal()
google()
mavenCentral()
}
Expand All @@ -37,16 +38,19 @@ buildscript {

plugins {
id "io.gitlab.arturbosch.detekt" version "1.17.1"
id 'maven-publish'
}

allprojects {
apply from: "$rootDir/detekt.gradle"
}

//allprojects {
// apply from: "$rootDir/detekt.gradle"
//}

tasks.detekt.jvmTarget = "1.8"

allprojects {
repositories {
mavenLocal()
google()
maven { url 'https://jitpack.io' }
mavenCentral()
Expand All @@ -56,3 +60,4 @@ allprojects {
task clean(type: Delete) {
delete rootProject.buildDir
}

0 comments on commit f78d5e3

Please sign in to comment.