Skip to content

Commit

Permalink
Add a documentation section to the README, linking to the typedoc git…
Browse files Browse the repository at this point in the history
…hub pages
  • Loading branch information
MajorLift committed Nov 26, 2023
1 parent 1cf6c7b commit e8a4644
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,14 @@ const unshiftPushJoin =
)));
```

## Documentation

For full documentation on all of the types included in this library, see: [https://majorlift.github.io/hkt-toolbelt/](https://majorlift.github.io/hkt-toolbelt/)

Note: The curried nature of the functions in this library is intended to be utilized to compose types using point-free style.

As a general principle, **`hkt-toolbelt`** types are written to first take in operations, and then the data to be operated on.

## Guides

We have additional resources to help you get started with **`hkt-toolbelt`**, that go in depth on the concepts and usage.
Expand Down

0 comments on commit e8a4644

Please sign in to comment.