Skip to content

Commit b00d8f1

Browse files
committed
Added JitPack to example build. Added installation notes to README.
1 parent ce1ce4a commit b00d8f1

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

README.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,23 @@ This repository contains Java bindings for the txtai API. Full txtai functionali
1111

1212
## Installation
1313

14-
Add the following lines to your project `build.gradle` file:
14+
Jitpack is the recommended way to integrate txtai with Java. See [this link](https://jitpack.io/) for how to install JitPack.
15+
16+
The following is an example adding txtai to a project's `build.gradle` file. The same attributes can be ported to other build systems per the JitPack link above.
1517

1618
```gradle
19+
implementation 'com.github.neuml:txtai.java:v1.0.0'
20+
```
21+
22+
txtai can also be manually built from GitHub.
23+
24+
```bash
25+
git clone https://github.com/neuml/txtai.java
26+
cd txtai.java
27+
./gradlew jar
1728
```
1829

19-
Other build systems such as Maven can use also use the same dependency string.
30+
The JAR will be available in ./build/libs
2031

2132
## Examples
2233
The examples directory has a series of examples that give an overview of txtai. See the list of examples below.

examples/build.gradle

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@ apply plugin: "java"
22

33
repositories {
44
mavenCentral()
5+
maven { url "https://jitpack.io" }
56
}
67

78
dependencies {
89
implementation "com.squareup.retrofit2:retrofit:2.9.0"
910
implementation "com.squareup.retrofit2:converter-gson:2.9.0"
10-
implementation files("../build/libs/txtai-1.0.0.jar")
11+
implementation 'com.github.neuml:txtai.java:master-SNAPSHOT'
1112
}
1213

1314
java {

0 commit comments

Comments
 (0)