Skip to content

Commit 6001719

Browse files
Improving installation steps for the js package (#125)
1 parent 995b8ab commit 6001719

File tree

2 files changed

+38
-36
lines changed

2 files changed

+38
-36
lines changed

README.md

Lines changed: 19 additions & 18 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 client library for TerminusDB and
15+
> TerminusX.
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
@@ -30,40 +30,41 @@ TerminusX is in public beta and you can [sign up now][dashboard].
3030

3131
## Requirements
3232

33-
- [NodeJS 10+](https://nodejs.org/en/)
33+
- Node.js version 10+ if using the TerminusDB client library as a Node.js package
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+
The TerminusDB JavaScript client library can be used either as a Node.js package
38+
or as a script that runs in the browser.
3839

39-
### NPM Module
40+
### NPM Package
4041

41-
Before installing, download and install Node.js.<br>
42-
NodeJS version 10.X or higher is required. NodeJS version 14.X is recommended.
42+
> :memo: If you don't already have Node.js installed, [install it][node-install] first.
4343
44-
Installation is done using the npm install command:
44+
[node-install]: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
4545

46-
Using npm:
46+
To install the `terminusdb-client` package as a dependency in an existing
47+
package, run:
4748

48-
```bash
49+
```sh
4950
$ npm install --save @terminusdb/terminusdb-client
5051
```
5152

52-
### Minified Script
53+
This command update your `package.json`.
5354

54-
Using cdn:
55+
### Script
56+
57+
To use the `terminusdb-client` script on a webpage sourced from a CDN, add this
58+
to your HTML:
5559

5660
```html
5761
<script src="https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js"></script>
5862
```
5963

60-
Downloading:
61-
62-
Download the terminusdb-client.min.js file from the /dist directory and save it to your location of choice, then:
64+
Alternatively, you can download the latest [`terminusdb-client.min.js`][js], add
65+
it to your sources, and use that in the `<script>` instead.
6366

64-
```html
65-
<script src="http://my.saved.location/terminusdb-client.min.js"></script>
66-
```
67+
[js]: https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js
6768

6869
## Usage
6970

docs/README.md

Lines changed: 19 additions & 18 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 client library for TerminusDB and
15+
> TerminusX.
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
@@ -30,40 +30,41 @@ TerminusX is in public beta and you can [sign up now][dashboard].
3030

3131
## Requirements
3232

33-
- [NodeJS 10+](https://nodejs.org/en/)
33+
- Node.js version 10+ if using the TerminusDB client library as a Node.js package
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+
The TerminusDB JavaScript client library can be used either as a Node.js package
38+
or as a script that runs in the browser.
3839

39-
### NPM Module
40+
### NPM Package
4041

41-
Before installing, download and install Node.js.<br>
42-
NodeJS version 10.X or higher is required. NodeJS version 14.X is recommended.
42+
> :memo: If you don't already have Node.js installed, [install it][node-install] first.
4343
44-
Installation is done using the npm install command:
44+
[node-install]: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
4545

46-
Using npm:
46+
To install the `terminusdb-client` package as a dependency in an existing
47+
package, run:
4748

48-
```bash
49+
```sh
4950
$ npm install --save @terminusdb/terminusdb-client
5051
```
5152

52-
### Minified Script
53+
This command update your `package.json`.
5354

54-
Using cdn:
55+
### Script
56+
57+
To use the `terminusdb-client` script on a webpage sourced from a CDN, add this
58+
to your HTML:
5559

5660
```html
5761
<script src="https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js"></script>
5862
```
5963

60-
Downloading:
61-
62-
Download the terminusdb-client.min.js file from the /dist directory and save it to your location of choice, then:
64+
Alternatively, you can download the latest [`terminusdb-client.min.js`][js], add
65+
it to your sources, and use that in the `<script>` instead.
6366

64-
```html
65-
<script src="http://my.saved.location/terminusdb-client.min.js"></script>
66-
```
67+
[js]: https://unpkg.com/@terminusdb/terminusdb-client/dist/terminusdb-client.min.js
6768

6869
## Usage
6970

0 commit comments

Comments
 (0)