From 243359e452f24276c764c51b0ba36a83688a0b7c Mon Sep 17 00:00:00 2001 From: Gritzko Daniel Kleiner Date: Fri, 24 Feb 2023 20:59:20 -0300 Subject: [PATCH] docs: update README (#3) Co-authored-by: @joaomantovani --- README.md | 6 +++--- package.json | 11 ++++++++--- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ec2014f..3d3efef 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,11 @@ >Made with [contributors-img](https://contrib.rocks). ____ -A successor package for [nodejs-health-checker](https://github.com/gritzkoo/nodejs-health-checker) to simplify health checks. +A successor package for [`nodejs-health-checker`](https://github.com/gritzkoo/nodejs-health-checker) to simplify health checks. -The main purpose of this package is to substitute `nodejs-health-checker` package and standardize the liveness and readiness actions for Nodejs applications running in Kubernetes deployments, without adding complexity and extra package installs. +The main purpose of this package is to substitute [`nodejs-health-checker`](https://github.com/gritzkoo/nodejs-health-checker) package and standardize the liveness and readiness actions for Nodejs applications running in Kubernetes deployments, without adding complexity and extra package installs. -Read more about migrating from `nodejs-health-checker` or creating your tests in [MIGRATIONS GUIDELINES](docs/MIGRATIONS.md) +Read more about migrating from [`nodejs-health-checker`](https://github.com/gritzkoo/nodejs-health-checker) or creating your tests in [MIGRATIONS GUIDELINES](docs/MIGRATIONS.md) ___ diff --git a/package.json b/package.json index 628d77a..58486f4 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "nodejs-health-checker-lw", - "version": "1.0.0", - "description": "A successor package for nodejs-health-checker", + "version": "1.0.1", + "description": "The main purpose of this package is to substitute nodejs-health-checker package and standardize the liveness and readiness actions for Nodejs applications running in Kubernetes deployments, without adding complexity and extra package installs.", "main": "dist/index.js", "scripts": { "test": "jest", @@ -15,9 +15,14 @@ "keywords": [ "healthcheck", "health-check", + "health-checker", + "healthchecker", "liveness", + "livenessProbe", "readiness", - "k8s-probes" + "readinessProbe", + "k8s-probes", + "pods" ], "author": "Gritzko D. Kleiner", "license": "MIT",