Update readme

karlomikus · Dec 7, 2023 · 2144237 · 2144237
1 parent 4626fc0
commit 2144237
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,7 @@
+/.github export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/phpunit.xml.dist export-ignore
+/tests export-ignore
+/ecs.php export-ignore
+/phpstan.neon export-ignore
diff --git a/README.md b/README.md
@@ -60,7 +60,9 @@ $ingredient = $ingredientParser->parseLine('15 lorem ingredient names');
 // $ingredient->units === 'test'
 ```
 
-## Convereter usage
+## Unit converter usage
+
+Simple unit conversion implemented with enums. Not made for accuracy. Handles mostly cocktail recipe units (ml, oz, cl, dash...). Can handle fractional display amounts (¾, 1 1/2..).
 
 ```php
 <?php