This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar-client-node.git
The following commit(s) were added to refs/heads/master by this push:
new a5c21b0 [Doc] Add links to client feature matrix in README.md (#323)
a5c21b0 is described below
commit a5c21b09f8712453c2b156ed885f426381ed4a2b
Author: Jun Ma <60642177+momo-...@users.noreply.github.com>
AuthorDate: Sat May 6 19:06:12 2023 +0800
[Doc] Add links to client feature matrix in README.md (#323)
---
README.md | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index bd4a126..7917679 100644
--- a/README.md
+++ b/README.md
@@ -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.
@@ -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.
@@ -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
