Skip to content

Commit 70767ee

Browse files
committed
Update usage instructions
Signed-off-by: Joshua Castle <26531652+Kas-tle@users.noreply.github.com>
1 parent 1984408 commit 70767ee

3 files changed

Lines changed: 33 additions & 2 deletions

File tree

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ jobs:
253253
PGP_SECRET: ${{ secrets.PGP_SECRET }}
254254
PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
255255
name: Publish to Maven Central
256-
- uses: Kas-tle/base-release-action@65d06f835be34757c6d73c16959c97e92c2a3c7f
256+
- uses: Kas-tle/base-release-action@3f67ffdb23c6a5267660b0e8c5beccf8056d7c44
257257
id: release
258258
with:
259259
files: |

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![Maven Central Version](https://img.shields.io/maven-central/v/dev.kastle.webrtc/webrtc-java?label=Maven%20Central&color=%233fb950)](https://repo1.maven.org/maven2/dev/kastle/webrtc/webrtc-java/)
2+
13
This is a fork of devopvoid's [webrtc-java](https://github.com/devopvoid/webrtc-java) library, a Java wrapper for the [WebRTC Native API](https://webrtc.github.io/webrtc-org/native-code/native-apis).
24

35
## Differences from the Original Project
@@ -18,6 +20,35 @@ The base project is published under the group `dev.kastle.webrtc` and artifact `
1820
- `macos-x86_64`
1921
- `macos-aarch64`
2022

23+
<details>
24+
<summary>Maven Usage</summary>
25+
26+
```xml
27+
<dependency>
28+
<groupId>dev.kastle.webrtc</groupId>
29+
<artifactId>webrtc-java</artifactId>
30+
<version>VERSION</version>
31+
<classifier>PLATFORM-ARCH</classifier>
32+
</dependency>
33+
```
34+
</details>
35+
36+
<details>
37+
<summary>Gradle Usage (Groovy)</summary>
38+
39+
```groovy
40+
implementation 'dev.kastle.webrtc:webrtc-java:VERSION:PLATFORM-ARCH'
41+
```
42+
</details>
43+
44+
<details>
45+
<summary>Gradle Usage (Kotlin DSL)</summary>
46+
47+
```kotlin
48+
implementation("dev.kastle.webrtc:webrtc-java:VERSION:PLATFORM-ARCH")
49+
```
50+
</details>
51+
2152
Note that the natives are not bundled with the main library, so you will need to appropriately include those that are needed for your project. If your project is an executable jar, you may want to read [JEP-472](https://openjdk.org/jeps/472). Because this project uses JNI, you may need to enable native access, depending on your Java version and execution environment. The main module is named `dev.kastle.webrtc`, and the natives modules are named `dev.kastle.webrtc.natives.<platform>` (e.g. `dev.kastle.webrtc.natives.linux.x86_64`), with any hyphens replaced by periods.
2253

2354
## Development

gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
version=1.0.1
1+
version=1.0.2

0 commit comments

Comments
 (0)