Skip to content

Commit

Permalink
Create links in README
Browse files Browse the repository at this point in the history
  • Loading branch information
benbellick committed Oct 14, 2024
1 parent 5180288 commit 7f1b783
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ppx_deriving_decoders: Automatically write mattjbray/ocaml-decoders

mattjbray/ocaml-decoders is an excellent library for writing decoders using decoding combinators. However, writing out decoders by hand for more complicated types can be quite time-intensive.
[mattjbray/ocaml-decoders](https://github.com/mattjbray/ocaml-decoders) is an excellent library for writing decoders using decoding combinators. However, writing out decoders by hand for more complicated types can be quite time-intensive.

This library helps by automatically producing the appropriate decoder for a particular type.

Expand All @@ -16,7 +16,7 @@ There are two primary ways in which this library can be of use. (More details of
opam install ppx_deriving_decoders
```

The implementation is agnostic to the underlying decoders backend. The only requirement is the presence of a module with the signature `Decoders.Decoder.S` as specified in mattjbray/ocaml-decoders, which is aliased to module `D`.
The implementation is agnostic to the underlying decoders backend. The only requirement is the presence of a module with the signature [`Decoders.Decoder.S`](https://github.com/mattjbray/ocaml-decoders/blob/59c0dfbe6026af27fce96af82e650a875157385d/src/sig.ml#L8) as specified in [mattjbray/ocaml-decoders](https://github.com/mattjbray/ocaml-decoders), which is aliased to module `D`.

E.g., if you wanted to decode using `yojson`, you could use
```
Expand Down

0 comments on commit 7f1b783

Please sign in to comment.