Skip to content

Commit

Permalink
Change initial version to 0.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Masahiro Sakamoto committed Aug 22, 2019
1 parent 5f8aadb commit 4464cb0
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 6 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@

The Pulsar Node.js client can be used to create Pulsar producers and consumers in Node.js.

## Compatibility

This Node.js client is developed and tested using Apache Pulsar 2.3.0

## Requirements

Pulsar Node.js client library is based on the C++ client library. Follow the instructions for
Expand All @@ -40,6 +36,16 @@ Pulsar Node.js client library is based on the C++ client library. Follow the ins
Also, this library works only in Node.js 10.x or later because it uses the
[node-addon-api](https://github.com/nodejs/node-addon-api) module to wrap the C++ library.

## Compatibility

Compatibility between each version of the Node.js client and the C++ client is as follows:

| Node.js client | C++ client |
|----------------|----------------|
| 0.0.1 | 2.3.0 or later |

If an incompatible version of the C++ client is installed, you may fail to build or run this library.

## How to build

### Install dependent npm modules and build Pulsar client library:
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

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

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "pulsar-client",
"version": "2.4.0-SNAPSHOT",
"version": "0.0.1-rc.0",
"description": "Pulsar Node.js client",
"main": "index.js",
"directories": {
Expand Down

0 comments on commit 4464cb0

Please sign in to comment.