You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-16Lines changed: 14 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,35 +15,33 @@
15
15
> This repository is for the JavaScript client library for TerminusDB and
16
16
> TerminusCMS.
17
17
18
-
[**TerminusDB**][terminusdb] is an [open-source][terminusdb-repo] graph database
19
-
and document store. It allows you to link JSON documents in a powerful knowledge
20
-
graph all through a simple document API.
18
+
[**TerminusDB**][terminusdb] is an [open-source][terminusdb-repo] graph database and document store. It allows you to link JSON documents in a powerful knowledge graph all through a simple document API.
**TerminusCMS** is a [headless content management system](https://terminusdb.com/terminuscms/) for complex enviroments. Try it out for yourself, it's free to get started with generous limits. Clone a demo project to play around. [Sign up][dashboard].
24
+
It is the model-based, in-memory, and distributed knowledge graph database for hierarchical records with a git-for-data collaboration model at its heart. So many great things in a single package and a high precision datalog query language with advanced features like transactions, schema validation and unification.
27
25
28
-
[dashboard]: https://dashboard.terminusdb.com/
26
+
For many, it serves as a headless content management system for complex enviroments with push, pull, clone, rebase and merge capabilities with immutable history and a strong schema checker that covers both the simplest and most advanced models.
27
+
28
+
Use the [cloud-based studio environment](https://studio.dfrnt.com/) to [build graph data products in the cloud](https://dfrnt.com/solutions-studio) or in your [localhost dockerized TerminusDB instances](https://terminusdb.org/docs/install-terminusdb-as-a-docker-container/). Try it out for yourself, it's free to get started with generous limits, clone a demo project to play around.
29
29
30
30
## Requirements
31
31
32
-
- Node.js version 10+ if using the TerminusDB client library as a Node.js package
32
+
- Node.js version 20+ if using the TerminusDB client library as a Node.js package (might work with earlier versions too).
33
33
34
34
## Installation
35
35
36
-
The TerminusDB JavaScript client library can be used either as a Node.js package
37
-
or as a script that runs in the browser.
36
+
The TerminusDB JavaScript client library can be used either as a Node.js package or as a script that runs in the browser.
38
37
39
38
### NPM Package
40
39
41
40
> :memo: If you don't already have Node.js installed, [install it][node-install] first.
@@ -139,7 +135,7 @@ async function createDataProduct(){
139
135
140
136
## Options
141
137
142
-
connections options.
138
+
Connections options.
143
139
144
140
To initialize `TerminusDB client` with custom options use
145
141
@@ -157,6 +153,8 @@ const client = new TerminusClient.WOQLClient("http://127.0.0.1:6363/", {
157
153
158
154
The TerminusDB API can be found at the [TerminusDB Documentation][terminusdb-docs].
159
155
156
+
TerminusDB communicates using JSON over HTTP. It works with advanced datatypes including integers, floats, decimals, big integers, arbitrary precision decimals, dates and other important XML Datatypes. Math is capped at 20 digits of precision, where the core is ready to support higher precision if needed.
157
+
160
158
## Report Issues
161
159
162
160
If you encounter any issues, please report it with your os and environment setup, the version that you are using, and a simple reproducible case.
0 commit comments