Skip to content

Commit

Permalink
updated readme, added install section
Browse files Browse the repository at this point in the history
Signed-off-by: Antonio Mendoza Pérez <[email protected]>
  • Loading branch information
antmendoza committed Jul 13, 2021
1 parent d668e88 commit 8ba8ece
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 23 deletions.
26 changes: 5 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,36 +27,20 @@ To build the project and run tests locally:
```sh
git clone https://github.com/serverlessworkflow/sdk-typescript.git
cd sdk-typescript
npm install && npm run test
npm install && npm run build && npm run test
```


### Add as dependency to your project
You can use [npm link](https://docs.npmjs.com/cli/v7/commands/npm-link) to add the `@severlessworkflow/sdk-typescript`
as dependency in your project.
### How to use

- Clone the `sdk-typescript` project and build it:
```sh
git clone https://github.com/serverlessworkflow/sdk-typescript.git
cd sdk-typescript
npm install && npm run build
```
#### Install

- Make the package visible globally to npm. Inside the `sdk-typescript\dist` project folder run:
```sh
npm link
```
For the latest stable version:

- Navigate to the folder/project in which you want to use the sdk, and run the following command:
```sh
npm link @severlessworkflow/sdk-typescript
npm i @severlessworkflow/sdk-typescript
```

It will create a symbolic link from globally-installed `@severlessworkflow/sdk-typescript` to `node_modules/` of the current folder.


### How to use

#### Create Workflow using builder API

```typescript
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 8ba8ece

Please sign in to comment.