Skip to content

Commit

Permalink
add readme and licence
Browse files Browse the repository at this point in the history
  • Loading branch information
vojtatranta committed Jan 24, 2024
1 parent 8818046 commit 9b8f3ea
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,40 @@

![Main workflow](https://github.com/vojtatranta/actual-maybe/actions/workflows/main.yml/badge.svg)

TBD
This is another library that mimicks standard Maybe monad known from many functional languages.

It it supplied with standard API such as: `Maybe.of`, `Maybe#map`, `Maybe#flatMap`. For more info, [look at the tests](./src/Maybe.test.ts).

## Docs

For documentation, [look at the tests](./src/Maybe.test.ts). All the cases are tested there along with TS typings.

## Installation

```
npm i --save actual-maybe
yarn add actual-maybe
pnpm i --save actual-maybe
bun i --save actual maybe
```

## Testing

Standard script:

```
npm run test --all
yarn test
bun run test
```

## Contributions

You are free to use this library propose any change in a pull request.

Cheers.
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "actual-maybe",
"version": "0.1.1",
"license": "MIT",
"dependencies": {
"@babel/core": "^7.16.0",
"@pmmmwh/react-refresh-webpack-plugin": "^0.5.3",
Expand Down

0 comments on commit 9b8f3ea

Please sign in to comment.