Skip to content

Commit

Permalink
Add usage recommendation to README
Browse files Browse the repository at this point in the history
I mostly want to mention nakai, which I have enjoyed using, and steer
people away from doing html with templates.
  • Loading branch information
michaeljones committed Nov 17, 2023
1 parent d3804a6 commit 7982ad4
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ parameters.
Matcha is basic but currently feature complete and well tested. If the repository looks inactive it
is because it is stable.

## Recommended Usage

Template languages like Matcha are useful to have in general and are particularly useful for generating unstructured
text. Matcha generates well typed code that avoids issues that some more dynamic templating systems have.

That said, if you're planning to generate structured output, it is sensible to use a better suited approach. For data
formats, this should be serialization and deserialization libraries. For formats like HTML, you would likely be better
using a library like [nakai](https://github.com/nakaixo/nakai).

## Installation

Download pre-built binaries for the latest release from the
Expand Down

0 comments on commit 7982ad4

Please sign in to comment.