Skip to content

Commit 0eaa231

Browse files
improving installation steps for the js package
1 parent 0c2ddb1 commit 0eaa231

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
[![npm version](https://img.shields.io/npm/v/@terminusdb/terminusdb-client?logo=npm)](https://www.npmjs.com/package/@terminusdb/terminusdb-client)
1212
[![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)
1313

14-
> This repository is for the JavaScript client for TerminusDB and TerminusX. The
15-
> JavaScript client runs in the browser and on Node.js.
14+
> This repository is for the JavaScript package for TerminusDB and TerminusX. The
15+
> JavaScript package runs in the browser and on Node.js.
1616
1717
[**TerminusDB**][terminusdb] is an [open-source][terminusdb-repo] graph database
1818
and document store. It allows you to link JSON documents in a powerful knowledge
@@ -34,7 +34,7 @@ TerminusX is in public beta and you can [sign up now][dashboard].
3434

3535
## Installation
3636

37-
TerminusDB Client can be used as either a Node.js module available through the npm registry, or directly included in web-sites by including the script tag below.
37+
TerminusDB Client JS package can be used as either a Node.js module available through the npm registry, or directly included in web-sites by including the script tag below.
3838

3939
### NPM Module
4040

@@ -43,12 +43,22 @@ NodeJS version 10.X or higher is required. NodeJS version 14.X is recommended.
4343

4444
Installation is done using the npm install command:
4545

46-
Using npm:
46+
Using npm we can install the package in a new NodeJs project or existing one using following commands:
47+
48+
Go to a NodeJs project folder:
49+
50+
```bash
51+
$ cd ../projectfolder/
52+
```
53+
54+
Install the package
4755

4856
```bash
4957
$ npm install --save @terminusdb/terminusdb-client
5058
```
5159

60+
This command will add `@terminusdb/terminusdb-client` as a dependency to a package.json
61+
5262
### Minified Script
5363

5464
Using cdn:

0 commit comments

Comments
 (0)