Skip to content

Commit f7f9d91

Browse files
Temp: Add JVM library and publishing task
Temp: Add JVM library and publishing task
1 parent 1b70183 commit f7f9d91

20 files changed

+569
-0
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,7 @@ Cargo.lock
88

99
# These are backup files generated by rustfmt
1010
**/*.rs.bk
11+
12+
*.dylib
13+
14+
ldk_node.kt

.idea/.gitignore

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

.idea/codeStyles/Project.xml

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

.idea/codeStyles/codeStyleConfig.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.

.idea/ldk-node.iml

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

.idea/modules.xml

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

.idea/vcs.xml

Lines changed: 7 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: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,31 @@
11
# ldk-lite
22
A Simplified API for LDK.
3+
4+
## Build and publish to local Maven repository
5+
```shell
6+
source uniffi_bindgen_generate_kotlin.sh
7+
cd ldk-node-jvm
8+
./gradlew publishToMavenLocal
9+
```
10+
11+
## How to Use
12+
To use the Kotlin language bindings for [`ldk-node`] in your JVM project, add the following to your gradle dependencies:
13+
```kotlin
14+
repositories {
15+
mavenCentral()
16+
}
17+
18+
dependencies {
19+
implementation("org.ldk:ldk-node:0.0.1")
20+
}
21+
```
22+
23+
You may then import and use the `org.ldk_node` library in your Kotlin code. For example:
24+
```kotlin
25+
import uniffi.ldk_node.Builder
26+
import uniffi.ldk_node.Node
27+
28+
fun main() {
29+
val node: Node = Builder().build()
30+
}
31+
```

ldk-node-jvm/.gitattributes

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#
2+
# https://help.github.com/articles/dealing-with-line-endings/
3+
#
4+
# These are explicitly windows files and should use crlf
5+
*.bat text eol=crlf
6+

ldk-node-jvm/.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Ignore Gradle project-specific cache directory
2+
.gradle
3+
4+
# Ignore Gradle build output directory
5+
build
6+
7+
.idea/

0 commit comments

Comments
 (0)