sijie commented on a change in pull request #1: Provide Node Client Library URL: https://github.com/apache/pulsar-client-node/pull/1#discussion_r264161315
########## File path: README.md ########## @@ -1 +1,51 @@ -# Pulsar Node Client +<!-- + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +--> + +# Pulsar Node.js client library + +The Pulsar Node.js client can be used to create Pulsar producers and consumers in Node.js. + +## Requirements + +Pulsar Node.js client library is based on the C++ client library. Follow the instructions for Review comment: I would suggest add a section `Compatibility`. So people would have an expectation on what eversion of this node js client was developed. E.g. `This NodeJS client is developed and tested using Apache Pulsar Client x.y.z`. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
