Skip to content

Commit a4ec76e

Browse files
committed
chore(README): add link to docs, precise tests, and add future plans
1 parent a5d569b commit a4ec76e

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ A typescript library to parse and manipulate [cooklang](https://cooklang.org/) r
66

77
This library provides a set of tools to work with recipes written in the Cooklang format. It allows you to parse recipes, extract ingredients, cookware, and timers, scale recipes, and generate shopping lists.
88

9+
The documentation is available at [https://cooklang-parser.tmlmt.com](https://cooklang-parser.tmlmt.com) (work in progress)
10+
911
## Features
1012

1113
- **Cooklang Compliant:** Fully compliant with the Cooklang specifications.
@@ -85,11 +87,17 @@ shoppingList.categorize();
8587
console.log(shoppingList.categories);
8688
```
8789

90+
## Future plans
91+
92+
I plan to further develop features depending on the needs I will encounter in using this library in a practical application.
93+
8894
## Test coverage
8995

90-
This project maintains a high level of test coverage to ensure reliability. You can run the tests yourself by cloning the repository and running `pnpm test`.
96+
This project include a test setup aimed at eventually ensuring reliable parsing/scaling of as many recipe use cases as possible.
97+
98+
You can run the tests yourself by cloning the repository and running `pnpm test`. To see the coverage report, run `pnpm run test:coverage`.
9199

92-
To see the coverage report, run `pnpm run test:coverage`.
100+
If you find any issue with your own examples of recipes, feel free to open an Issue and if you want to help fix it, to submit a Pull Request.
93101

94102
## License
95103

0 commit comments

Comments
 (0)