@agoralabs-sh/vip030026

<div align="center">

[![License: CC0-1.0](https://img.shields.io/badge/License-CC0_1.0-brightgreen.svg)](./LICENSE)
[![NPM Version](https://img.shields.io/npm/v/%40agoralabs-sh%2Fvip030026)](https://www.npmjs.com/package/%40agoralabs-sh/vip030026)

</div>

<div align="center">

![GitHub Release](https://img.shields.io/github/v/release/agoralabs-sh/avm-tools?filter=%40agoralabs-sh%2Fvip030026*)
![GitHub Release](https://img.shields.io/github/v/release/agoralabs-sh/avm-tools?include_prereleases&filter=%40agoralabs-sh%2Fvip030026*&label=pre-release)

</div>

<h1 align="center">
  @agoralabs-sh/vip030026
</h1>

<p align="center">
  Various utilities and tools that allow for the creation and manipulation of credentials that conform to the VIP-03-0026 standard.
</p>

---

### Table Of Contents

* [1. Getting Started](#-2-getting-started)
  - [1.1. Installation](#12-installation)
* [2. Appendix](#-2-appendix)
  - [2.1. Useful Commands](#21-useful-commands)
* [3. How To Contribute](#-3-how-to-contribute)
* [4. License](#-4-license)

## 🪄 1. Getting Started

### 1.1. Installation

You can install the types using:
```shell
pnpm add @agoralabs-sh/vip030026
```

<sup>[Back to top ^][table-of-contents]</sup>

## 📑 2. Appendix

### 2.1. Useful Commands

| Command                   | Description                                                                 |
|---------------------------|-----------------------------------------------------------------------------|
| `pnpm run build`          | Generates build and TypeScript declaration files to the `dist/` directory.  |
| `pnpm run clean`          | Deletes the `dist/` directory and the `tsconfig.*.tsbuildinfo` files.       |
| `pnpm run generate:index` | Generates/overwrites the main `index.ts` file used for exporting all files. |
| `pnpm run lint`           | Runs the linter based on the rules in `eslint.config.mjs`.                  |
| `pnpm run prettier`       | Runs the prettier based on the rules in `prettier.config.mjs`.              |
| `pnpm run prettier`       | Runs the prettier based on the rules in `prettier.config.mjs`.              |
| `pnpm test`               | Runs tests using `vitest`.                                                  |

<sup>[Back to top ^][table-of-contents]</sup>

## 👏 3. How To Contribute

Please read the [**Contributing Guide**][contribute] to learn about the development process.

<sup>[Back to top ^][table-of-contents]</sup>

## 📄 4. License

Please refer to the [LICENSE][license] file.

<sup>[Back to top ^][table-of-contents]</sup>

<!-- links -->
[contribute]: ../../CONTRIBUTING.md
[license]: LICENSE
[table-of-contents]: #table-of-contents