Skip to content

Commit 7feb5ca

Browse files
Fix autogeneraed README
1 parent e6401b4 commit 7feb5ca

3 files changed

Lines changed: 28 additions & 8 deletions

File tree

.github/document.sh

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
export FL_TITLE="Functional"
2-
export FL_DESCRIPTION="Common Functional Programming Algebraic data types for JavaScript that is compatible with most modern browsers and Deno."
3-
export FL_VERSION="v1.3.0"
2+
export FL_DESCRIPTION="Common Functional Programming Algebraic data types for JavaScript that is compatible with most \
3+
modern browsers and Deno."
4+
export FL_GITHUB_URL="https://github.com/sebastienfilion/functional"
5+
export FL_DENO_URL="https://deno.land/x/functional"
6+
export FL_VERSION="v1.3.1"
47

5-
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
8+
deno run --allow-all --unstable ../@functional:generate-documentation/cli.js document \
9+
"$FL_TITLE" \
10+
"$FL_DESCRIPTION" \
11+
$FL_GITHUB_URL \
12+
$FL_DENO_URL \
13+
$FL_VERSION \
14+
./.github/readme-fragment-usage.md \
15+
./library/*.js \
16+
./.github/readme-fragment-typescript.md \
17+
./.github/readme-fragment-license.md

.github/readme-fragment-usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ sayHello(userID).run()
4040

4141
### Using the bundle
4242

43-
As a convenience, when using Functional in the browser, you can use the **unminified** bundled copy.
43+
As a convenience, when using Functional in the browser, you can use the **unminified** bundled copy (18KB gzipped).
4444

4545
```js
4646
import { compose, converge, lift, map, prop } from "https://deno.land/x/ramda@v0.27.2/mod.ts";

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

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

5-
[![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)
5+
[![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)
66
[![deno version](https://img.shields.io/badge/deno-^1.6.1-lightgrey?logo=deno)](https://github.com/denoland/deno)
7-
[![GitHub release](https://img.shields.io/github/v/release/sebastienfilion/functional-redis)](https://github.com/sebastienfilion/functional-redis/releases)
8-
[![GitHub licence](https://img.shields.io/github/license/sebastienfilion/functional-redis)](https://github.com/sebastienfilion/functional-redis/blob/v1.3.0/LICENSE)
7+
[![GitHub release](https://img.shields.io/github/v/release/sebastienfilion/functional)](https://github.com/sebastienfilion/functional/releases)
8+
[![GitHub licence](https://img.shields.io/github/license/sebastienfilion/functional)](https://github.com/sebastienfilion/functional/blob/v1.3.1/LICENSE)
99

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

547547
```ts
548-
import { Either, IO, Maybe, Task, factorizeType, factorySumType } from "https://deno.land/x/functional@v1.3.0/mod.ts";
548+
import {
549+
Either,
550+
IO,
551+
Maybe,
552+
Pair,
553+
Task,
554+
factorizeType,
555+
factorySumType
556+
} from "https://deno.land/x/functional@v1.3.0/mod.ts";
549557
```
550558

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

0 commit comments

Comments
 (0)