Release v1.0.1

* Update README.md

* Update types

Co-authored-by: Tom McLean <[email protected]>

Author: kael89

README.md

@@ -1,6 +1,6 @@
 # @beyondessential/arithmetic
 
-Utility to evaluate [BODMAS](https://en.wikipedia.org/wiki/Order_of_operations) arithmetic formulas
+Utility to evaluate [BODMAS](https://en.wikipedia.org/wiki/Order_of_operations) arithmetic formulas. It is an implementation of the [shunting yard algorithm](https://en.wikipedia.org/wiki/Shunting-yard_algorithm). 
 
 ### Installation
 
@@ -15,5 +15,11 @@ yarn add beyondessential/arithmetic
 ```js
 import { runArithmetic } from '@beyondessential/arithmetic';
 
-runArithmetic('(1 + 2) / 3');
+const value = runArithmetic('(-1 + 2.5) / 3');
+console.log(value); // 0.5
+
+const valueWithVariable = runArithmetic('2 * four', {
+  four: 4
+});
+console.log(valueWithVariable); // 8
 ```

index.d.ts

@@ -1 +1 @@
-export function runArithmetic(formula: string): number;
+export function runArithmetic(formula: string, values?: Record<string, string | number>): number;