@tmlmt/cooklang-parser 2.0.0 → 2.0.2

package/README.md

@@ -2,35 +2,34 @@
 
 A typescript library to parse and manipulate [cooklang](https://cooklang.org/) recipes.
 
+<picture><img src="https://badges.ws/maintenance/yes/2025" /></picture>
+<picture><img src="https://badges.ws/npm/dt/@tmlmt/cooklang-parser" /></picture>
+<picture><img src="https://badges.ws/npm/l/@tmlmt/cooklang-parser" /></picture>
+<picture><img src="https://badges.ws/github/release/tmlmt/cooklang-parser" /></picture>
+[<img src="https://badges.ws/badge/documentation-5672CD?icon=vitepress" />](https://cooklang-parser.tmlmt.com)
+
 ## Introduction
 
 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.
 
-The documentation is available at [https://cooklang-parser.tmlmt.com](https://cooklang-parser.tmlmt.com) (work in progress)
-
 ## Features
 
 - **Cooklang Compliant:** Fully compliant with the Cooklang specifications.
-- **Recipe Parsing:** Parse Cooklang recipes to extract metadata, ingredients, cookware, timers, and steps. Several extensions on top of the original cooklang specifications:
-  - **Useful modifiers:** in line with the same in the canonical cooklang parser in Rust ([cooklang-rs](https://github.com/cooklang/cooklang-rs/blob/main/extensions.md))
-    - `@`: referenced recipe
-    - `&`: referenced ingredient (quantities will be added)
-    - `-`: hidden ingredient
-    - `?`: optional ingredient
-  - **Range values:**
-    - `@eggs{2-4}` will show eggs as an ingredient with a quantity range of 2 to 4
-    - `@water{1%L} and @&water{1/4-1/2%L}` will show water as an ingredient with a quantity range of 1.25 to 1.5 L
-    - Also works with Cookware and Timers
+- **Recipe Parsing:** Parse Cooklang recipes to extract metadata, ingredients, cookware, timers, and steps.
+  Several extensions on top of the original cooklang specifications
+  and [detailed in the docs](https://cooklang-parser.tmlmt.com/guide-extensions).
 - **Recipe Scaling:** Scale recipes by a given factor.
 - **Shopping Lists:** Generate shopping lists from one or more recipes.
-- **Aisle Configuration:** Categorize shopping list ingredients based on a custom aisle configuration.
+- **Category Configuration:** Categorize shopping list ingredients based on a custom category configuration.
 - **Typescript:** Written in Typescript, providing type safety for all the data structures.
 
 ## Quick start
 
-Install the package with your favorite package manager e.g. `npm install @tmlmt/cooklang-parser`
+- Install the package with your favorite package manager, e.g.:
+
+`npm install @tmlmt/cooklang-parser`
 
-To get started, you can use the `Recipe` class to parse a cooklang recipe:
+- Use the `Recipe` class to parse a cooklang recipe:
 
 ```typescript
 import { Recipe } from "@tmlmt/cooklang-parser";
@@ -52,50 +51,18 @@ Serve hot.
 const recipe = new Recipe(recipeString);
 
 console.log(recipe.metadata.title); // "Pancakes"
-console.log(recipe.ingredients);
-console.log(recipe.cookware);
-console.log(recipe.timers);
-```
-
-You can also create a shopping list from multiple recipes:
-
-```typescript
-import { ShoppingList, Recipe } from "@tmlmt/cooklang-parser";
-
-const recipe1 = new Recipe(/* ... */);
-const recipe2 = new Recipe(/* ... */);
-
-const shoppingList = new ShoppingList();
-shoppingList.add_recipe(recipe1);
-shoppingList.add_recipe(recipe2);
-
-console.log(shoppingList.ingredients);
+console.log(recipe.ingredients); // [{ name: "eggs", ...}, ...]
+console.log(recipe.cookware); // [{ name: "pan", ...}]
+console.log(recipe.timers); // [{ duration: 15, unit: "minutes", name: undefined}]
 ```
 
-And you can categorize those ingredients according to an aisle configuration defined in the cooklang format:
-
-```typescript
-const shoppingList = `
-[Dairy]
-milk
-butter
-
-[Bakery]
-flour
-sugar
-`;
-
-shoppingList.set_aisle_config(aisleConfig);
-shoppingList.categorize();
-
-console.log(shoppingList.categories);
-```
+- Browse the [API Reference](https://cooklang-parser.tmlmt.com/api/classes/Recipe) to discover all functionalities
 
 ## Future plans
 
-I plan to further develop features depending on the needs I will encounter in using this library in a practical application. The current todo includes:
+I plan to further develop features depending on the needs or bugs I will encounter in using this library in a practical application. Current backlog is as follows:
 
-- Ingredients aliases. See issue tmlmt/cooklang-parser#5
+- Pantry parsing and basic functions (e.g. take pantry into account when creating a shopping list)
 
 ## Test coverage
 
@@ -103,8 +70,6 @@ This project includes a test setup aimed at eventually ensuring reliable parsing
 
 You can run the tests yourself by cloning the repository and running `pnpm test`. To see the coverage report, run `pnpm test:coverage`.
 
-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.
-
-## License
+## Contributing
 
-MIT
+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.