docs: update README (#3)

Co-authored-by: @joaomantovani
gritzkoo · Feb 24, 2023 · 243359e · 243359e
1 parent 4b234fc
commit 243359e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git 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
@@ -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",