Skip to content

Commit

Permalink
Fix autogeneraed README
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastienfilion committed Dec 20, 2020
1 parent e6401b4 commit ea22ff7
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 7 deletions.
18 changes: 15 additions & 3 deletions .github/document.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
export FL_TITLE="Functional"
export FL_DESCRIPTION="Common Functional Programming Algebraic data types for JavaScript that is compatible with most modern browsers and Deno."
export FL_VERSION="v1.3.0"
export FL_DESCRIPTION="Common Functional Programming Algebraic data types for JavaScript that is compatible with most \
modern browsers and Deno."
export FL_GITHUB_URL="https://github.com/sebastienfilion/functional"
export FL_DENO_URL="https://deno.land/x/functional"
export FL_VERSION="v1.3.1"

deno run --allow-all --unstable ../@functional:generate-documentation/cli.js document "$FL_TITLE" "$FL_DESCRIPTION" $FL_VERSION ./.github/readme-fragment-usage.md ./library/*.js ./.github/readme-fragment-typescript.md ./.github/readme-fragment-license.md
deno run --allow-all --unstable ../@functional:generate-documentation/cli.js document \
"$FL_TITLE" \
"$FL_DESCRIPTION" \
$FL_GITHUB_URL \
$FL_DENO_URL \
$FL_VERSION \
./.github/readme-fragment-usage.md \
./library/*.js \
./.github/readme-fragment-typescript.md \
./.github/readme-fragment-license.md
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

Common Functional Programming Algebraic data types for JavaScript that is compatible with most modern browsers and Deno.

[![deno land](http://img.shields.io/badge/available%20on-deno.land/x-lightgrey.svg?logo=deno&labelColor=black)](https://deno.land/x/functional-redis@v1.3.0)
[![deno land](http://img.shields.io/badge/available%20on-deno.land/x-lightgrey.svg?logo=deno&labelColor=black)](https://deno.land/x/functional@v1.3.1)
[![deno version](https://img.shields.io/badge/deno-^1.6.1-lightgrey?logo=deno)](https://github.com/denoland/deno)
[![GitHub release](https://img.shields.io/github/v/release/sebastienfilion/functional-redis)](https://github.com/sebastienfilion/functional-redis/releases)
[![GitHub licence](https://img.shields.io/github/license/sebastienfilion/functional-redis)](https://github.com/sebastienfilion/functional-redis/blob/v1.3.0/LICENSE)
[![GitHub release](https://img.shields.io/github/v/release/sebastienfilion/functional)](https://github.com/sebastienfilion/functional/releases)
[![GitHub licence](https://img.shields.io/github/license/sebastienfilion/functional)](https://github.com/sebastienfilion/functional/blob/v1.3.1/LICENSE)

* [Either](#either)
* [IO](#io)
Expand Down Expand Up @@ -545,7 +545,15 @@ returned. But if the container is `Either.Left`, it will throw an error with the
You can import any types or the factories through `mod.ts`.

```ts
import { Either, IO, Maybe, Task, factorizeType, factorySumType } from "https://deno.land/x/functional@v1.3.0/mod.ts";
import {
Either,
IO,
Maybe,
Pair,
Task,
factorizeType,
factorySumType
} from "https://deno.land/x/functional@v1.3.0/mod.ts";
```

Or, you can import individual sub-module with the appropriate TypeScript hint in Deno.
Expand Down

0 comments on commit ea22ff7

Please sign in to comment.