Skip to content

Commit

Permalink
Add a warning about roughness of library
Browse files Browse the repository at this point in the history
  • Loading branch information
benbellick committed Oct 14, 2024
1 parent 71e732f commit bc96663
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ There are two primary ways in which this library can be of use. (More details of
1. "I want to write a (e.g. JSON) decoder for a particular type but don't care about the details" --> You can then use this library via `[@@deriving decoders]` applied to your types.
2. "I want to write a (e.g. JSON) decoder for a particular type, but I care a lot about how it works and just want a good starting place" --> You can use this library via `[@@deriving_inline decoders]` applied to your types to generate the implementation in place.

> [!WARNING]
> This is still a fairly experimental library. Use at your own risk! If you would like to use it and be extra safe, use approach 2 above, by using the library to generate boilerplate, but remove the dependency in production code.
## Getting Started

Expand Down

0 comments on commit bc96663

Please sign in to comment.