solar-conflux/typescript/option/README.md

![npm (scoped)](https://img.shields.io/npm/v/@adrielus/option?style=for-the-badge)
![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@adrielus/option?style=for-the-badge)
[![forthebadge](https://forthebadge.com/images/badges/powered-by-water.svg)](https://forthebadge.com)

# Option

## Installation

```sh
npm install @adrielus/option
```

(There is also an amd build at `/dist/bundle.amd.js` which uses the `Option` namespace)

## Usage

For detailed usage read [the docs](docs/main.md)

# Contributing

First, clone this repo:

```sh
git clone https://github.com/Mateiadrielrafael/option
cd option
```

Then use **_pnpm_** to install the dependencies:

```sh
pnpm install
```

You can use the `build` command to build the package (this is dont automatically by github actions):

```sh
pnpm run build
```