From 132ac8c93b9dfefca6e9c32c5e45f2c44b51f77a Mon Sep 17 00:00:00 2001
From: Aviad Hahami <ahahami@paloaltonetworks.com>
Date: Thu, 20 Jul 2023 15:31:17 -0400
Subject: [PATCH] chore: updated readme

- Improved wording
- Moved links from `kr1sp1n` to `nodevault`; This Will also prevent future repojacking
---
 .devcontainer/devcontainer.json |  3 ++-
 README.md                       | 34 ++++++++++++++++++---------------
 2 files changed, 21 insertions(+), 16 deletions(-)

diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
index f45ef95..a0ff1fe 100644
--- a/.devcontainer/devcontainer.json
+++ b/.devcontainer/devcontainer.json
@@ -20,7 +20,8 @@
 				"github.copilot",
 				"streetsidesoftware.code-spell-checker",
 				"redhat.vscode-yaml",
-				"GitHub.copilot"
+				"GitHub.copilot",
+				"yzhang.markdown-all-in-one"
 			]
 		}
 	}
diff --git a/README.md b/README.md
index 4d09a4c..e017a31 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # node-vault
 
-[![Build Status](https://img.shields.io/github/checks-status/kr1sp1n/node-vault/master.svg?style=flat-square)](https://github.com/nodevault/node-vault/actions?query=branch%3Amaster)
+[![Build Status](https://img.shields.io/github/checks-status/nodevault/node-vault/master.svg?style=flat-square)](https://github.com/nodevault/node-vault/actions?query=branch%3Amaster)
 [![Coverage Status](https://img.shields.io/codecov/c/github/nodevault/node-vault/master.svg?style=flat-square)](https://app.codecov.io/gh/nodevault/node-vault/tree/master)
 [![Download Status](https://img.shields.io/npm/dm/node-vault.svg?style=flat-square)](https://www.npmjs.com/package/node-vault)
 [![test](https://img.shields.io/npm/v/node-vault?style=flat-square)](https://www.npmjs.com/package/node-vault)
@@ -11,20 +11,24 @@ A client for the HTTP API of HashiCorp's [Vault] written for Node.js.
 
 
 ## Install
-make sure to use node.js version >= 6
+Prerequisites:
+ - NodeJS >= `16.0.0`
 
-    npm install node-vault
-
-
-## Test
+```bash
+npm install -S node-vault
+```
 
-Run tests inside docker to do also nice integration testing:
+> The year is 2023; If, for whatever reason, you need to use an older version of node.js (yet still `>= 6.x`), use `node-vault <= v0.10.0`
+>
+> Please note that `node-vault <= v0.10.0` contains multiple vulnerabilities ☠️
 
-    docker-compose up --force-recreate test
 
-This will create containers for vault, postgres and running the tests inside
-docker.
+## Test
 
+Run tests using docker-compose (includes vault, postgres and running the tests inside) with:
+```bash
+docker-compose up --force-recreate test
+```
 
 ## Usage
 
@@ -34,7 +38,7 @@ docker.
 var options = {
   apiVersion: 'v1', // default
   endpoint: 'http://127.0.0.1:8200', // default
-  token: '1234' // optional client token; can be fetched after valid initialization of the server
+  token: 'MY_TOKEN' // optional client token; can be fetched after valid initialization of the server
 };
 
 // get new instance of the client
@@ -72,7 +76,7 @@ Instead of installing all the dependencies like vault itself, postgres and other
 use [docker] and [docker-compose] to link and run multiple docker containers with all of its dependencies.
 
 ```bash
-git clone git@github.com:kr1sp1n/node-vault.git
+git clone git@github.com:nodevault/node-vault.git
 cd node-vault
 docker-compose up vault
 ```
@@ -116,11 +120,11 @@ const vault = require('node-vault')(options);
 
 [![Backers](https://opencollective.com/node-vault/tiers/backers.svg?avatarHeight=80&width=600)](https://opencollective.com/node-vault/contribute)
 
-[examples]: https://github.com/kr1sp1n/node-vault/tree/master/example
-[docker-compose.yml]: https://github.com/kr1sp1n/node-vault/tree/master/docker-compose.yml
+[examples]: https://github.com/nodevault/node-vault/tree/master/example
+[docker-compose.yml]: https://github.com/nodevault/node-vault/tree/master/docker-compose.yml
 [Vault]: https://vaultproject.io/
 [docker-compose]: https://www.docker.com/docker-compose
 [docker]: http://docs.docker.com/
 [docker toolbox]: https://www.docker.com/toolbox
 [docco]: http://jashkenas.github.io/docco
-[feature list]: https://github.com/kr1sp1n/node-vault/tree/master/features.md
+[feature list]: https://github.com/nodevault/node-vault/tree/master/features.md