Skip to content

Commit bcbe868

Browse files
committed
chore: updated readme
- Improved wording - Moved links from `kr1sp1n` to `nodevault`; This Will also prevent future repojacking
1 parent e709b04 commit bcbe868

File tree

2 files changed

+21
-16
lines changed

2 files changed

+21
-16
lines changed

.devcontainer/devcontainer.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
"github.copilot",
2121
"streetsidesoftware.code-spell-checker",
2222
"redhat.vscode-yaml",
23-
"GitHub.copilot"
23+
"GitHub.copilot",
24+
"yzhang.markdown-all-in-one"
2425
]
2526
}
2627
}

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# node-vault
22

3-
[![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)
3+
[![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)
44
[![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)
55
[![Download Status](https://img.shields.io/npm/dm/node-vault.svg?style=flat-square)](https://www.npmjs.com/package/node-vault)
66
[![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.
1111

1212

1313
## Install
14-
make sure to use node.js version >= 6
14+
Prerequisites:
15+
- NodeJS >= `16.0.0`
1516

16-
npm install node-vault
17-
18-
19-
## Test
17+
```bash
18+
npm install -S node-vault
19+
```
2020

21-
Run tests inside docker to do also nice integration testing:
21+
> 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`
22+
>
23+
> Please note that `node-vault <= v0.10.0` contains multiple vulnerabilities ☠️
2224
23-
docker-compose up --force-recreate test
2425

25-
This will create containers for vault, postgres and running the tests inside
26-
docker.
26+
## Test
2727

28+
Run tests using docker-compose (includes vault, postgres and running the tests inside) with:
29+
```bash
30+
docker-compose up --force-recreate test
31+
```
2832

2933
## Usage
3034

@@ -34,7 +38,7 @@ docker.
3438
var options = {
3539
apiVersion: 'v1', // default
3640
endpoint: 'http://127.0.0.1:8200', // default
37-
token: '1234' // optional client token; can be fetched after valid initialization of the server
41+
token: 'MY_TOKEN' // optional client token; can be fetched after valid initialization of the server
3842
};
3943

4044
// get new instance of the client
@@ -72,7 +76,7 @@ Instead of installing all the dependencies like vault itself, postgres and other
7276
use [docker] and [docker-compose] to link and run multiple docker containers with all of its dependencies.
7377

7478
```bash
75-
git clone [email protected]:kr1sp1n/node-vault.git
79+
git clone [email protected]:nodevault/node-vault.git
7680
cd node-vault
7781
docker-compose up vault
7882
```
@@ -116,11 +120,11 @@ const vault = require('node-vault')(options);
116120

117121
[![Backers](https://opencollective.com/node-vault/tiers/backers.svg?avatarHeight=80&width=600)](https://opencollective.com/node-vault/contribute)
118122

119-
[examples]: https://github.com/kr1sp1n/node-vault/tree/master/example
120-
[docker-compose.yml]: https://github.com/kr1sp1n/node-vault/tree/master/docker-compose.yml
123+
[examples]: https://github.com/nodevault/node-vault/tree/master/example
124+
[docker-compose.yml]: https://github.com/nodevault/node-vault/tree/master/docker-compose.yml
121125
[Vault]: https://vaultproject.io/
122126
[docker-compose]: https://www.docker.com/docker-compose
123127
[docker]: http://docs.docker.com/
124128
[docker toolbox]: https://www.docker.com/toolbox
125129
[docco]: http://jashkenas.github.io/docco
126-
[feature list]: https://github.com/kr1sp1n/node-vault/tree/master/features.md
130+
[feature list]: https://github.com/nodevault/node-vault/tree/master/features.md

0 commit comments

Comments
 (0)