Skip to content
This repository has been archived by the owner on Apr 8, 2024. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jwulf committed Jun 15, 2020
1 parent 2a8635b commit 2332e31
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@

This is a Node.js gRPC client for [Zeebe](https://zeebe.io). It is written in TypeScript and transpiled to JavaScript in the `dist` directory.

Versions from 0.23.0 require Node 14.x.
Versions prior to 0.23.0 require Node 8 or above.

Comprehensive API documentation is available [online](https://creditsenseau.github.io/zeebe-client-node-js/).

See [CHANGELOG.md](./CHANGELOG.md) to see what has changed with each release.
Expand All @@ -20,6 +17,7 @@ Get a hosted instance of Zeebe on [Camunda Cloud](https://camunda.io).
## Table of Contents

- [ Versioning ](#versioning)
- [ gRPC Implementation ](#grpc-implementation)
- [ Type difference from other Zeebe clients ](#type-difference)
- [ A note on representing timeout durations ](#time-duration)

Expand Down Expand Up @@ -95,6 +93,18 @@ NPM Package version 0.22.x supports Zeebe 0.22.x

NPM Package version 0.21.x supports Zeebe 0.21.x

<a name="grpc-implementation"></a>

## gRPC Implementation

The Zeebe Node client uses the C gRPC client implementation [grpc-node](https://github.com/grpc/grpc-node) by default.

From 0.23.3, you can opt-in to use the pure JavaScript implementation [@grpc/grpc-js](https://www.npmjs.com/package/@grpc/grpc-js), to assist us in testing it.

To activate the pure JavaScript implementation, set `ZEEBE_NODE_PUREJS=true`.

Please report any issues in [GitHub](https://github.com/creditsenseau/zeebe-client-node-js/issues).

<a name = "type-difference"></a>

## Type difference from other Zeebe clients
Expand Down

0 comments on commit 2332e31

Please sign in to comment.