From 068f6ebd508c84f1e6c7be07127097a86d57702b Mon Sep 17 00:00:00 2001 From: Matei Adriel Date: Thu, 19 Dec 2019 14:06:56 +0200 Subject: [PATCH] typescript(option): chore: added a Readme Signed-off-by: prescientmoon --- typescript/option/README.md | 38 +++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 typescript/option/README.md diff --git a/typescript/option/README.md b/typescript/option/README.md new file mode 100644 index 0000000..2ec954c --- /dev/null +++ b/typescript/option/README.md @@ -0,0 +1,38 @@ +![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 + +Curently there are no docs, but all functions have the same type definition as the ones from [fsharp](https://msdn.microsoft.com/en-us/visualfsharpdocs/conceptual/core.option-module-%5Bfsharp%5D) (except the ones from my package are not curreied) + +# 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 +```