Skip to content

Commit

Permalink
Added a better README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jordanburke committed Nov 1, 2024
1 parent cd0f4c9 commit 46a5498
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,25 @@
# functype

A small functional library for TypeScript inspired by Scala Standard Library.
A small functional library for TypeScript inspired by FP, Scala Standard Library, and ZIO

[![Node.js Build](https://github.com/jordanburke/functype/actions/workflows/pnpm-build.yml/badge.svg)](https://github.com/jordanburke/functype/actions/workflows/pnpm-build.yml)

# Functype - A Functional Library for TypeScript

Functype is a functional programming library for TypeScript, inspired by FP, Scala's standard library and ZIO. It offers a collection of utilities and abstractions to facilitate functional programming paradigms within TypeScript applications. The library is designed to provide developers with tools that promote immutability, pure functions, and composability, aligning with functional programming principles.

## Key Features

- **Functional Utilities:** Functype includes a variety of functions and combinators that assist in writing functional code, such as `map`, `filter`, and `reduce` operations tailored for TypeScript.

- **Type Safety:** Leveraging TypeScript's type system, Functype ensures that functional operations are type-safe, reducing runtime errors and enhancing code reliability.

- **Immutability Support:** The library emphasizes immutable data structures, encouraging developers to write predictable and side-effect-free code.

- **Type Orientation:** Functype encourages TypeScript developers to adopt functional programming principles through type annotations and type inference.

- **Composability:** Functype provides a collection of abstractions and utilities for composing complex functional programs.

## Installation

You can install `functype` using any package manager:
Expand All @@ -19,3 +35,7 @@ pnpm install functype
```bash
yarn install functype
```

```bash
bun install functype
```

0 comments on commit 46a5498

Please sign in to comment.