Skip to content

Commit a70136d

Browse files
authored
Merge pull request #21 from bci-oss/fix-installation-instructions
Fix installation instructions
2 parents 695976d + 66b6c4c commit a70136d

File tree

1 file changed

+7
-14
lines changed
  • documentation/js-sdk-aml-guide/modules/ROOT/pages

1 file changed

+7
-14
lines changed

documentation/js-sdk-aml-guide/modules/ROOT/pages/index.adoc

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,11 @@ For example a newly added property and the related value could be shown in the U
1818

1919
== Getting Started
2020

21-
=== Install from the public npm (Currently not available):
21+
=== Install from GitHub release repository
2222

23-
[source,bash]
24-
----
25-
npm install @esmf/aspect-model-loader
26-
----
27-
28-
=== Install from github release repository:
29-
30-
[source,bash]
23+
[source,shell,subs="attributes+,+quotes"]
3124
----
32-
npm install https://github.com/eclipse-esmf/esmf-sdk-js-aspect-model-loader/releases/download/<TAG_VERSION>/esmf-aspect-model-loader-x.x.x.tgz
25+
npm install https://github.com/eclipse-esmf/esmf-sdk-js-aspect-model-loader/releases/download/v{esmf-sdk-js-aspect-model-loader-version}/esmf-aspect-model-loader-{esmf-sdk-js-aspect-model-loader-version}.tgz
3326
----
3427

3528
== Usage
@@ -38,7 +31,7 @@ This package contains two methods for loading Turtle (.ttl) files (string value
3831

3932
Load an aspect model which is self-contained (includes no imports to other ttl file):
4033

41-
[source,bash]
34+
[source,javascript]
4235
----
4336
new AspectModelLoader().loadSelfContainedModel(ttl).subscribe((aspect: Aspect) => {
4437
...
@@ -47,7 +40,7 @@ new AspectModelLoader().loadSelfContainedModel(ttl).subscribe((aspect: Aspect) =
4740

4841
or if the model contains imports to additional ttl files:
4942

50-
[source,bash]
43+
[source,javascript]
5144
----
5245
new AspectModelLoader().load('<aspect-model-urn>', ttl-1, ttl-2, ttl-3).subscribe((aspect: Aspect) => {
5346
...
@@ -62,14 +55,14 @@ This module exposes some helper functions that can be used to find items inside
6255

6356
Find a specific model element, and returns it or undefined.
6457

65-
[source,bash]
58+
[source,javascript]
6659
----
6760
let specificElement = loader.findByUrn(options.urnSelectedModelElement)
6861
----
6962

7063
Find a specific model element by name, and returns the found elements.
7164

72-
[source,bash]
65+
[source,javascript]
7366
----
7467
let specificElement = loader.findByName(options.selectedModelName)
7568
----

0 commit comments

Comments
 (0)