prescientmoon/solar-conflux
1
Fork 0
Code Activity

typescript(option): chore: added a Readme

Browse source 
Signed-off-by: prescientmoon <git@moonythm.dev>
This commit is contained in:
Matei Adriel 2019-12-19 14:06:56 +02:00 committed by prescientmoon
parent 9a2ff8d174
commit 068f6ebd50
Signed by: prescientmoon
SSH key fingerprint: SHA256:UUF9JT2s8Xfyv76b8ZuVL7XrmimH4o49p4b+iexbVH4
1 changed files with 38 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
typescript/option/README.md Normal file
View file

@ -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
```