Skip to content

update readme #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gcanti merged 1 commit into from
Jun 24, 2025
Merged

update readme #85

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 7 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,6 @@ flowchart TD
- **Unified Representation Of Optics**. All optics compose the same way because they are all instances of the same data type (`Optic`)
- **Integration**. Built-in optics for `effect` data structures, like `Option` and `Either`.

## Introduction

`@fp-ts/optic` is a library that makes it easy to modify parts of larger data structures based on a single representation of an optic as a combination of a getter and setter.

`@fp-ts/optic` features a unified representation of optics, deep `effect` integration, helpful error messages.

# Credits and sponsorship

This library was inspired by the following projects:

- [zio-optics](https://github.com/zio/zio-optics)
- [monocle-ts](https://github.com/gcanti/monocle-ts)

A huge thanks to my sponsors who made the development of `@fp-ts/optic` possible.

If you also want to **become a sponsor** to ensure this library continues to improve and receive maintenance, check out my [GitHub Sponsors profile](https://github.com/sponsors/gcanti?o=sd&sc=t)

## Requirements

- TypeScript 5.4 or newer
Expand All @@ -72,8 +55,6 @@ To install the **alpha** version:
npm install @fp-ts/optic
```

**Warning**. This package is primarily published to receive early feedback and for contributors, during this development phase we cannot guarantee the stability of the APIs, consider each release to contain breaking changes.

Once you have installed the library, you can import the necessary types and functions from the `@fp-ts/optic` module.

```ts
Expand Down Expand Up @@ -601,6 +582,13 @@ const updatedData: Data = pipe(data, Optic.replace(_foo)(10)); // returns { foo:

- [API Reference](https://fp-ts.github.io/optic/)

# Credits

This library was inspired by the following projects:

- [zio-optics](https://github.com/zio/zio-optics)
- [monocle-ts](https://github.com/gcanti/monocle-ts)

# License

The MIT License (MIT)
Loading