Skip to content

Commit d879553

Browse files
committed
improved README with instructions to donwload from NPM
1 parent 8ec6d8c commit d879553

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,19 @@ The following JavaScript modules are currently available:
1414
You need an Oracle Database to make use of the JavaScript modules provided in the Oracle Database Multilingual Engine (MLE).
1515
A very convenient way of getting an Oracle Database instance is to create an always-free Oracle Cloud account and set up a free autonomous database instance there as our [blog article][2] explains in great detail.
1616

17-
The declaration files can be installed into your project directory using NPM:
17+
The declaration files can conveniently be installed into your project directory using NPM:
1818

1919
```
20-
git clone [email protected]:oracle-samples/mle-modules.git
21-
npm install mle-modules/declarations/mle-js-oracledb
22-
npm install mle-modules/declarations/mle-js-bindings
23-
npm install mle-modules/declarations/mle-js-plsqltypes
20+
npm install mle-js-oracledb
21+
npm install mle-js-bindings
22+
npm install mle-js-plsqltypes
23+
```
24+
25+
Alternatively, you can also download `mle-js` which is a single bundled ambient file for all these module declarations in one.
26+
You can conveniently install it from NPM and then reference it in the beginning of your JavaScript code using the `<reference>` tag:
27+
```
28+
npm install mle-js
29+
/// <reference types="./node_modules/mle-js/mle-js.d.ts" />
2430
```
2531

2632
## Documentation

0 commit comments

Comments
 (0)