Skip to content

Commit b949994

Browse files
committed
Update README for 6.0 release, closes #23
1 parent 476f8b8 commit b949994

File tree

2 files changed

+26
-10
lines changed

2 files changed

+26
-10
lines changed

README.md

+25-9
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,29 @@
1-
# txtai: Semantic search and workflows in Java
1+
<p align="center">
2+
<img src="https://raw.githubusercontent.com/neuml/txtai/master/logo.png"/>
3+
</p>
24

3-
[![Version](https://img.shields.io/github/release/neuml/txtai.java.svg?style=flat&color=success)](https://github.com/neuml/txtai.java/releases)
4-
[![GitHub Release Date](https://img.shields.io/github/release-date/neuml/txtai.java.svg?style=flat&color=blue)](https://github.com/neuml/txtai.java/releases)
5-
[![GitHub issues](https://img.shields.io/github/issues/neuml/txtai.java.svg?style=flat&color=success)](https://github.com/neuml/txtai.java/issues)
6-
[![GitHub last commit](https://img.shields.io/github/last-commit/neuml/txtai.java.svg?style=flat&color=blue)](https://github.com/neuml/txtai.java)
5+
<p align="center">
6+
<b>Java client for txtai</b>
7+
</p>
78

8-
[txtai](https://github.com/neuml/txtai) is an open-source platform for semantic search and workflows powered by language models.
9+
<p align="center">
10+
<a href="https://github.com/neuml/txtai.java/releases">
11+
<img src="https://img.shields.io/github/release/neuml/txtai.java.svg?style=flat&color=success" alt="Version"/>
12+
</a>
13+
<a href="https://github.com/neuml/txtai.java/releases">
14+
<img src="https://img.shields.io/github/release-date/neuml/txtai.java.svg?style=flat&color=blue" alt="GitHub Release Date"/>
15+
</a>
16+
<a href="https://github.com/neuml/txtai.java/issues">
17+
<img src="https://img.shields.io/github/issues/neuml/txtai.java.svg?style=flat&color=success" alt="GitHub Issues"/>
18+
</a>
19+
<a href="https://github.com/neuml/txtai.java">
20+
<img src="https://img.shields.io/github/last-commit/neuml/txtai.java.svg?style=flat&color=blue" alt="GitHub Last Commit"/>
21+
</a>
22+
</p>
923

10-
This repository contains Java bindings for the txtai API. Full txtai functionality is supported.
24+
[txtai](https://github.com/neuml/txtai) is an all-in-one embeddings database for semantic search, LLM orchestration and language model workflows.
25+
26+
This repository contains Java bindings for the txtai API.
1127

1228
## Installation
1329

@@ -16,7 +32,7 @@ Jitpack is the recommended way to integrate txtai with Java. See [this link](htt
1632
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.
1733

1834
```gradle
19-
implementation 'com.github.neuml:txtai.java:v5.5.0'
35+
implementation 'com.github.neuml:txtai.java:v6.0.0'
2036
```
2137

2238
txtai can also be manually built from GitHub.
@@ -39,7 +55,7 @@ The examples directory has a series of examples that give an overview of txtai.
3955
| [Labeling with zero-shot classification](https://github.com/neuml/txtai.java/blob/master/examples/src/main/java/LabelsDemo.java) | Labeling with zero-shot classification |
4056
| [Pipelines and workflows](https://github.com/neuml/txtai.java/blob/master/examples/src/main/java/PipelinesDemo.java) | Pipelines and workflows |
4157

42-
txtai.java connects to a txtai api instance. See [this link](https://github.com/neuml/txtai#api) for details on how to start a new api instance.
58+
txtai.java connects to a txtai api instance. See [this link](https://neuml.github.io/txtai/api/) for details on how to start a new api instance.
4359

4460
Once an api instance is running, do the following to run the examples.
4561

build.gradle

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ java {
1717

1818
jar {
1919
archiveBaseName = "txtai"
20-
archiveVersion = "5.5.0"
20+
archiveVersion = "6.0.0"
2121
}

0 commit comments

Comments
 (0)