pulsar-client 0.0.1-rc.1 → 1.0.1

package/.eslintignore

@@ -17,4 +17,5 @@
 # under the License.
 #
 
+examples
 perf

package/README.md

@@ -42,10 +42,22 @@ Compatibility between each version of the Node.js client and the C++ client is a
 
 | Node.js client | C++ client     |
 |----------------|----------------|
-| 0.0.1          | 2.3.0 or later |
+| 1.0.0          | 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 install
+
+### Please install pulsar-client in your project:
+
+```shell
+$ npm install pulsar-client
+```
+
+## Sample code
+
+Please refer to [examples](https://github.com/apache/pulsar-client-node/tree/master/examples).
+
 ## How to build
 
 ### Install dependent npm modules and build Pulsar client library:

package/examples/consumer.js

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-const Pulsar = require('../index.js');
+const Pulsar = require('pulsar-client');
 
 (async () => {
   // Create a client

package/examples/consumer_tls_auth.js

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-const Pulsar = require('../index.js');
+const Pulsar = require('pulsar-client');
 
 (async () => {
   const auth = new Pulsar.AuthenticationTls({

package/examples/producer.js

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-const Pulsar = require('../index.js');
+const Pulsar = require('pulsar-client');
 
 (async () => {
   // Create a client

package/examples/producer_tls_auth.js

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-const Pulsar = require('../index.js');
+const Pulsar = require('pulsar-client');
 
 (async () => {
   const auth = new Pulsar.AuthenticationTls({

package/examples/reader.js

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-const Pulsar = require('../index.js');
+const Pulsar = require('pulsar-client');
 
 (async () => {
   // Create a client

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pulsar-client",
-  "version": "0.0.1-rc.1",
+  "version": "1.0.1",
   "description": "Pulsar Node.js client",
   "main": "index.js",
   "directories": {