Skip to content

Commit 0a7bdae

Browse files
committed
Update README header image, intro text
[skip-ci]
1 parent ebc81ce commit 0a7bdae

File tree

1 file changed

+25
-14
lines changed

1 file changed

+25
-14
lines changed

README.md

Lines changed: 25 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,32 @@
1-
TerminusDB Client Javascript
2-
==========================
1+
[![TerminusDB JavaScript Client](https://assets.terminusdb.com/readmes/terminusdb-client-js/header.gif)][terminusdb-client-js-docs]
32

4-
[![Discord online](https://img.shields.io/discord/689805612053168129?color=7289da&logo=Discord&label=Discord%20chat)](https://discord.gg/yTJKAma)
5-
[![Discourse topics](https://img.shields.io/discourse/topics?color=yellow&logo=Discourse&server=https%3A%2F%2Fdiscuss.terminusdb.com%2F)](https://discuss.terminusdb.com/)
6-
[![Follow on Twitter](https://img.shields.io/twitter/follow/terminusdb?color=skyblue&label=Follow%20on%20Twitter&logo=twitter&style=flat)](https://twitter.com/TerminusDB)
3+
[terminusdb-client-js-docs]: https://terminusdb.github.io/terminusdb-client-js/
74

8-
**Development status ⚙️**
5+
---
96

10-
[![build status](https://api.travis-ci.com/terminusdb/terminusdb-client.svg?branch=main)](https://travis-ci.com/terminusdb/terminusdb-client)
11-
[![Coverage Status](https://coveralls.io/repos/github/terminusdb/terminusdb-client/badge.svg?branch=master)](https://coveralls.io/repos/github/terminusdb/terminusdb-client/badge.svg?branch=master)
7+
[![Discord](https://img.shields.io/discord/689805612053168129?label=Discord&logo=Discord&style=plastic)](https://discord.gg/yTJKAma)
8+
[![Discourse](https://img.shields.io/discourse/topics?color=yellow&logo=Discourse&server=https%3A%2F%2Fdiscuss.terminusdb.com%2F&style=plastic)](https://discuss.terminusdb.com/)
9+
[![Twitter](https://img.shields.io/twitter/follow/terminusdb?color=skyblue&label=Follow%20on%20Twitter&logo=twitter&style=flat)](https://twitter.com/TerminusDB)
1210

13-
**NPM Package status 📦**
11+
[![npm version](https://img.shields.io/npm/v/@terminusdb/terminusdb-client?logo=npm)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
12+
[![npm downloads](https://img.shields.io/npm/dw/@terminusdb/terminusdb-client?color=red&label=npm%20package&logo=npm&style=flat)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
1413

15-
[![npm version shields.io](https://img.shields.io/npm/v/@terminusdb/terminusdb-client?logo=npm)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
16-
[![PyPI download month](https://img.shields.io/npm/dw/@terminusdb/terminusdb-client?color=red&label=npm%20package&logo=npm&style=flat)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
14+
> This repository is for the JavaScript client for TerminusDB and TerminusX. The
15+
> JavaScript client runs in the browser and on Node.js.
1716
18-
Promise based terminus client for the browser and node.js
17+
[**TerminusDB**][terminusdb] is an [open-source][terminusdb-repo] graph database
18+
and document store. It allows you to link JSON documents in a powerful knowledge
19+
graph all through a simple document API.
20+
21+
[terminusdb]: https://terminusdb.com/
22+
[terminusdb-docs]: https://terminusdb.com/docs/
23+
[terminusdb-repo]: https://github.com/terminusdb/terminusdb
24+
25+
**TerminusX** is a self-service data platform that allows you to build, deploy,
26+
execute, monitor, and share versioned data products. It is built on TerminusDB.
27+
TerminusX is in public beta and you can [sign up now][dashboard].
28+
29+
[dashboard]: https://dashboard.terminusdb.com/
1930

2031
## Requirements
2132

@@ -59,7 +70,7 @@ Download the terminusdb-client.min.js file from the /dist directory and save it
5970
This example creates a simple dataProduct, starting to create a database model the schema
6071
and insert a simple document
6172

62-
For the [full Documentation](https://terminusdb.github.io/terminusdb-client-js/)
73+
For the [full Documentation][terminusdb-client-js-docs]
6374

6475
```javascript
6576
const TerminusClient = require("@terminusdb/terminusdb-client");
@@ -144,7 +155,7 @@ const client = new TerminusClient.WOQLClient("http://127.0.0.1:6363/", {
144155

145156
## API
146157

147-
The API of the most recent release is documented at: <https://terminusdb.com/docs/v10.0/#/reference/reference-api>
158+
The TerminusDB API can be found at the [TerminusDB Documentation][terminusdb-docs].
148159

149160
## Report Issues
150161

0 commit comments

Comments
 (0)