arecibo - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

package.json

 {
   "name": "arecibo",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Fastify plugin that respondes to kubernetes readiness and liveness probes.",
@@ -5,0 +5,0 @@ "main": "./build/index.js",

README.md

 # arecibo
 Fastify ping responder for Kubernetes Liveness and Readiness Probes
 
-## Usage
+## Installation
 
-Install with ```npm i arecibo```
+`npm i arecibo`
 
-On Kubernetes deployment manifest adds 
+## Usage 
+
+```JS
+const arecibo = require('arecibo') // or import arecibo from 'arecibo'
+
+fastify.register(arecibo, {
+  message: 'Put here your custom message', // optional, default to original arecibo message 
+  readinessURL: '/put/here/your/custom/url', // optional, deafult to /arecibo/readiness
+  livenessURL: '/put/here/your/custom/url', // optional, deafult to /arecibo/liveness
+  readinessCallback: (req, reply) =>  reply.type('text/html').send('Put here your custom message') // optional
+  livenessCallback: (req, reply) =>  reply.type('text/html').send('Put here your custom message') // optional
+})
+
+```
+
+On Kubernetes add deployment manifest
+
 ```YAML
+...
 livenessProbe:
@@ -30,2 +47,3 @@ httpGet:
 periodSeconds: 15
+...
 ```
@@ -32,0 +50,0 @@

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17106

increased by3.7%

Number of lines in readme file

52

increased by52.94%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes