Skip to content

Commit

Permalink
Update readme.md (#170)
Browse files Browse the repository at this point in the history
  • Loading branch information
jlucaspains authored Jan 15, 2025
1 parent d455202 commit 2cef82f
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

A simple recipe ingredient and instruction parser that avoids regexes as much as possible.

See online demo at [share-recipe-parser.lpains.net](https://sharp-recipe-parser.lpains.net/).

## Getting started
Install package from [npmjs.com](https://www.npmjs.com/package/@jlucaspains/sharp-recipe-parser):
```bash
Expand Down Expand Up @@ -154,4 +156,4 @@ I've tried a few models such as the [New York Times Ingredient Phrase Tagger](ht
The library was developed side-by-side with [Sharp Cooking](https://github.com/jlucaspains/sharp-cooking-web). As soon as version 1 of the library is released, I expected Sharp Cooking will leverage it in PROD as well.

4. Why not regex?
Regex quickly becomes clunky and hard to understand at a glance. There are reasonably simple rules that can be followed to parse and understand a recipe using a tokenizer and dictionaries to lookup specific data.
Regex quickly becomes clunky and hard to understand at a glance. There are reasonably simple rules that can be followed to parse and understand a recipe using a tokenizer and dictionaries to lookup specific data.

0 comments on commit 2cef82f

Please sign in to comment.