diff --git a/README.md b/README.md index f52fd3f..c932b9b 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,29 @@ -# txtai: Semantic search and workflows in JavaScript - -[![Version](https://img.shields.io/github/release/neuml/txtai.js.svg?style=flat&color=success)](https://github.com/neuml/txtai.js/releases) -[![GitHub Release Date](https://img.shields.io/github/release-date/neuml/txtai.js.svg?style=flat&color=blue)](https://github.com/neuml/txtai.js/releases) -[![GitHub issues](https://img.shields.io/github/issues/neuml/txtai.js.svg?style=flat&color=success)](https://github.com/neuml/txtai.js/issues) -[![GitHub last commit](https://img.shields.io/github/last-commit/neuml/txtai.js.svg?style=flat&color=blue)](https://github.com/neuml/txtai.js) - -[txtai](https://github.com/neuml/txtai) is an open-source platform for semantic search and workflows powered by language models. - -This repository contains JavaScript bindings for the txtai API. Full txtai functionality is supported. +

+ +

+ +

+ JavaScript client for txtai +

+ +

+ + Version + + + GitHub Release Date + + + GitHub Issues + + + GitHub Last Commit + +

+ +[txtai](https://github.com/neuml/txtai) is an all-in-one embeddings database for semantic search, LLM orchestration and language model workflows. + +This repository contains JavaScript bindings for the txtai API. ## Installation txtai.js can be installed via npm @@ -24,7 +40,7 @@ The examples directory has a series of examples that give an overview of txtai. | [Labeling with zero-shot classification](https://github.com/neuml/txtai.js/blob/master/examples/node/src/labels.js) | Labeling with zero-shot classification | | [Pipelines and workflows](https://github.com/neuml/txtai.js/blob/master/examples/node/src/pipelines.js) | Pipelines and workflows | -txtai.js 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. +txtai.js 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. Once an api instance is running, do the following to run the examples. diff --git a/examples/node/package.json b/examples/node/package.json index cc4716d..3b0c352 100644 --- a/examples/node/package.json +++ b/examples/node/package.json @@ -2,7 +2,7 @@ "name": "txtai-node", "dependencies": { "sprintf-js": ">=1.1.2", - "txtai": ">=5.5.0" + "txtai": ">=6.0.0" }, "devDependencies": { "@babel/cli": ">=7.10.5", diff --git a/package.json b/package.json index 66ab9ed..1ee5a15 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { "name": "txtai", - "version": "5.5.0", + "version": "6.0.0", "author": "NeuML", - "description": "Semantic search and workflows in JavaScript", + "description": "JavaScript client for txtai", "license": "Apache-2.0", "keywords": ["search", "nlp", "machine-learning", "similarity"], "repository": "neuml/txtai.js",