Skip to content

Commit

Permalink
README: clarify the difference between stable and experimental modules,
Browse files Browse the repository at this point in the history
closes #571
  • Loading branch information
gcanti committed Mar 15, 2021
1 parent b88a20c commit 920b21e
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,11 @@ npm i io-ts fp-ts

- [`index.ts` module](index.md)

## Experimental features (version `2.2+`)
## Experimental modules (version `2.2+`)

Experimental features (\*) are published in order to get early feedback from the community, see these tracking [issues](https://github.com/gcanti/io-ts/issues?q=label%3Av2.2+) for further discussions and enhancements.
Experimental modules (\*) are published in order to get early feedback from the community, see these tracking [issues](https://github.com/gcanti/io-ts/issues?q=label%3Av2.2+) for further discussions and enhancements.

The experimental modules are **independent and backward-incompatible** with stable ones.

- [`Decoder.ts` module](Decoder.md)
- [`Encoder.ts` module](Encoder.md)
Expand Down

0 comments on commit 920b21e

Please sign in to comment.