Skip to content

[Doc] Add links to client feature matrix in README.md #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tisonkun merged 2 commits into from
May 6, 2023
Merged

[Doc] Add links to client feature matrix in README.md #323

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef8fad6
Update README.md
momo-jun May 6, 2023
36bfb55
Update README.md
momo-jun May 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

# Pulsar Node.js client library

The Pulsar Node.js client can be used to create Pulsar producers and consumers in Node.js.
The Pulsar Node.js client can be used to create Pulsar producers and consumers in Node.js. For the supported Pulsar features, see [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/).

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.
Expand Down Expand Up @@ -96,7 +96,7 @@ You can see more examples in the [examples](./examples) directory. However, sinc

> **Note**
>
> Build from source code requires the Node.js version greater than 16.18
> Building from source code requires a Node.js version greater than 16.18.

First, clone the repository.

Expand Down Expand Up @@ -159,9 +159,15 @@ Sent message: my-message-9

## Documentation

* Please see https://pulsar.apache.org/docs/client-libraries-node/ for more details about the Pulsar Node.js client.
For more details about Pulsar Node.js clients, see [Pulsar docs](https://pulsar.apache.org/docs/client-libraries-node/).

You can generate the API docs by:
### Contribute

Contributions are welcomed and greatly appreciated.

If your contribution adds Pulsar features for Node.js clients, you need to update both the [Pulsar docs](https://pulsar.apache.org/docs/client-libraries/) and the [Client Feature Matrix](https://pulsar.apache.org/client-feature-matrix/). See [Contribution Guide](https://pulsar.apache.org/contribute/site-intro/#pages) for more details.

### Generate API docs

```shell
npm install
Expand Down