Skip to content

Commit

Permalink
chore: pretty docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shahradelahi committed Jun 23, 2024
1 parent 61976d5 commit 0bb00d3
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ and [Zod](https://github.com/colinhacks/zod).

---

- [Features](#features)
- [Features](#-features)
- [Installation](#-installation)
- [Usage](#-usage)
- [Init and unseal vault](#init-and-unseal-vault)
Expand All @@ -26,9 +26,10 @@ and [Zod](https://github.com/colinhacks/zod).
- [Contributing](#-contributing)
- [License](#license)

## Features
## 👀 Features

- Typesafe and Validated API
- Simple API
- Typesafe and Validated Requests from Zod
- Extendable using Custom Commands

## 📦 Installation
Expand All @@ -50,7 +51,7 @@ const vc = new Client({
endpoint: 'http://127.0.0.1:8200', // default
token: 'hv.xxxxxxxxxxxxxxxxxxxxx' // Optional in case you want to initialize the vault
});
// { data: xxx }

// Init vault
const init = await vc.init({ secret_shares: 1, secret_threshold: 1 });
console.log(init); // { data: { keys: [ ... ], keys_base64: [ ... ], ... } }
Expand All @@ -72,7 +73,7 @@ const mounted = await vc.mount({
type: 'kv-v2'
});

console.log(mounted); // true
console.log(mounted); // { data: true }

const info = await vc.engineInfo({ mountPath: 'my-secret' });

Expand Down

0 comments on commit 0bb00d3

Please sign in to comment.