pg-notify - npm Package Compare versions

Comparing version 0.0.7 to 0.0.8

package.json

 {
   "name": "pg-notify",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "Postgres pubsub client",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -31,2 +31,21 @@ <h1 align="center">Welcome to pg-notify 👋</h1>
 
+## Usage
+
+```js
+const PGPubSub = require('pg-notify')
+// import PGPubSub from 'pg-notify
+
+;(async () => {
+  const pubsub = new PGPubSub({
+    db: { connectionString: 'postgres://postgres:postgres@localhost:5432/db' }
+  })
+  await pubsub.connect()
+
+  await pubsub.on('test', (payload) => {
+    console.log('payload: ', payload)
+  })
+  await pubsub.emit({ topic: 'test', payload: 'this is the payload' })
+})()
+```
+
 ## Contributing
@@ -33,0 +52,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12949

increased by3.29%

Number of lines in readme file

59

increased by47.5%

No dependency changes