Skip to content

Commit 4948184

Browse files
committed
updated readme.md
Signed-off-by: Antonio Mendoza Pérez <antonio.mendoza@bideaavant.com>
1 parent a26c08a commit 4948184

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Serverless Workflow Specification - Typescript SDK
22

3-
Provides the Java API/SPI for the [Serverless Workflow Specification](https://github.com/serverlessworkflow/specification)
3+
Provides the Typescript API/SPI for the [Serverless Workflow Specification](https://github.com/serverlessworkflow/specification)
44

55

66
With the SDK you can:
@@ -15,17 +15,36 @@ With the SDK you can:
1515

1616
To build the project and run tests locally:
1717

18-
```
18+
```sh
1919
git clone https://github.com/serverlessworkflow/sdk-typescript.git
20+
cd sdk-typescript
2021
npm install && npm run test
2122
```
2223

2324

2425
### Add as dependency to your project
26+
You can use [npm link](https://docs.npmjs.com/cli/v7/commands/npm-link) to add the `sdk-typescript`
27+
as dependency in your project.
28+
29+
- Clone the `sdk-typescript` project and build it:
2530
```sh
26-
npm install sdk-typescript
31+
git clone https://github.com/serverlessworkflow/sdk-typescript.git
32+
cd sdk-typescript
33+
npm install && npm run build
2734
```
2835

36+
- Make the package visible globally to npm. Inside the `sdk-typescript` project folder run:
37+
```sh
38+
npm link
39+
```
40+
41+
- Navigate to the folder/project in which you want to use the sdk, and run the following command:
42+
```sh
43+
npm link sdk-typescript
44+
```
45+
46+
It will create a symbolic link from globally-installed `sdk-typescript` to `node_modules/` of the current folder.
47+
2948

3049
### How to use
3150

@@ -53,7 +72,7 @@ npm install sdk-typescript
5372
```typescript
5473
const workflow = BaseWorkflow.fromSource(source)
5574
```
56-
Where source is the file location.
75+
Where `source` is the file location.
5776

5877

5978

@@ -85,7 +104,7 @@ by using the static methods `toJSON` or `toYAML` respectively:
85104
```
86105

87106
```typescript
88-
const workFlowAsYAML = BaseWorkflow.toYAML(workflow);
107+
const workflowAsYAML = BaseWorkflow.toYAML(workflow);
89108
```
90109

91110

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)